From 40e20d6d633b36c3e415a6ccb079ceb34ca04a94 Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Mon, 16 Jun 2025 16:01:30 -0700 Subject: [PATCH 01/10] Adding some generated docs based on our schema files --- schema/connector-yaml.json | 1 + schema/dataconnect-yaml.json | 1 + schema/docs/connector-yaml.md | 765 +++++ schema/docs/dataconnect-yaml.md | 353 +++ schema/docs/extension-yaml.md | 2011 ++++++++++++ schema/docs/firebase-config.md | 4764 ++++++++++++++++++++++++++++ schema/docs/index.md | 5 + schema/extension-yaml.json | 8 +- schema/firebase-config.json | 1 + scripts/docs-gen/index.js | 13 + scripts/docs-gen/package-lock.json | 1049 ++++++ scripts/docs-gen/package.json | 15 + 12 files changed, 8984 insertions(+), 2 deletions(-) create mode 100644 schema/docs/connector-yaml.md create mode 100644 schema/docs/dataconnect-yaml.md create mode 100644 schema/docs/extension-yaml.md create mode 100644 schema/docs/firebase-config.md create mode 100644 schema/docs/index.md create mode 100644 scripts/docs-gen/index.js create mode 100644 scripts/docs-gen/package-lock.json create mode 100644 scripts/docs-gen/package.json diff --git a/schema/connector-yaml.json b/schema/connector-yaml.json index 729a747d128..744dfe8390a 100644 --- a/schema/connector-yaml.json +++ b/schema/connector-yaml.json @@ -1,5 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "connector.yaml", "additionalProperties": false, "definitions": { "javascriptSdk": { diff --git a/schema/dataconnect-yaml.json b/schema/dataconnect-yaml.json index cc68ac5c24f..18f7b1da9ab 100644 --- a/schema/dataconnect-yaml.json +++ b/schema/dataconnect-yaml.json @@ -1,5 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "dataconnect.yaml", "additionalProperties": false, "definitions": { "postgresql": { diff --git a/schema/docs/connector-yaml.md b/schema/docs/connector-yaml.md new file mode 100644 index 00000000000..23b43eb46af --- /dev/null +++ b/schema/docs/connector-yaml.md @@ -0,0 +1,765 @@ + + +# + + + + + + + + +
$idconnector.yaml
$schemahttp://json-schema.org/draft-07/schema#
+ +## Properties + +
NameType
connectorIdString
generateObject
+ + + +
+ + +## connectorId + + + + + + + + + + + + + + + +
DescriptionThe ID of the Firebase Data Connect connector.
TypeString
RequiredNo
+ + + + +## generate + + + + + + + + + + + +
TypeObject
RequiredNo
+ +### Properties +
NameType
javascriptSdkOne of:Object
Array
dartSdkOne of:Object
Array
kotlinSdkOne of:Object
Array
swiftSdkOne of:Object
Array
llmToolsOne of:Object
Array
+ + +### generate.javascriptSdk + + + + + + + + + + + + + + + +
DescriptionConfiguration for a generated Javascript SDK
TypeOne of:Object
Array
RequiredNo
+ + + +### generate.javascriptSdk.0 + + + + + + + +
TypeObject
+ + + +### generate.javascriptSdk.0.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + +### generate.javascriptSdk.0.package + + + + + + + + + + + +
DescriptionThe package name to use for the generated code.
TypeString
+ + + + +### generate.javascriptSdk.0.packageJSONDir + + + + + + + + + + + +
DescriptionThe directory containining the package.json to install the generated package in.
TypeString
+ + + + + +### generate.javascriptSdk.1 + + + + + + + +
TypeArray
+ + + +### generate.javascriptSdk.1.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + +### generate.javascriptSdk.1.package + + + + + + + + + + + +
DescriptionThe package name to use for the generated code.
TypeString
+ + + + +### generate.javascriptSdk.1.packageJSONDir + + + + + + + + + + + +
DescriptionThe directory containining the package.json to install the generated package in.
TypeString
+ + + + + + +### generate.dartSdk + + + + + + + + + + + + + + + +
DescriptionConfiguration for a generated Dart SDK
TypeOne of:Object
Array
RequiredNo
+ + + +### generate.dartSdk.0 + + + + + + + +
TypeObject
+ + + +### generate.dartSdk.0.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + +### generate.dartSdk.0.package + + + + + + + + + + + +
DescriptionThe package name to use for the generated code.
TypeString
+ + + + + +### generate.dartSdk.1 + + + + + + + +
TypeArray
+ + + +### generate.dartSdk.1.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + +### generate.dartSdk.1.package + + + + + + + + + + + +
DescriptionThe package name to use for the generated code.
TypeString
+ + + + + + +### generate.kotlinSdk + + + + + + + + + + + + + + + +
DescriptionConfiguration for a generated Kotlin SDK
TypeOne of:Object
Array
RequiredNo
+ + + +### generate.kotlinSdk.0 + + + + + + + +
TypeObject
+ + + +### generate.kotlinSdk.0.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + +### generate.kotlinSdk.0.package + + + + + + + + + + + +
DescriptionThe package name to use for the generated code.
TypeString
+ + + + + +### generate.kotlinSdk.1 + + + + + + + +
TypeArray
+ + + +### generate.kotlinSdk.1.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + +### generate.kotlinSdk.1.package + + + + + + + + + + + +
DescriptionThe package name to use for the generated code.
TypeString
+ + + + + + +### generate.swiftSdk + + + + + + + + + + + + + + + +
DescriptionConfiguration for a generated Swift SDK
TypeOne of:Object
Array
RequiredNo
+ + + +### generate.swiftSdk.0 + + + + + + + +
TypeObject
+ + + +### generate.swiftSdk.0.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + + +### generate.swiftSdk.1 + + + + + + + +
TypeArray
+ + + +### generate.swiftSdk.1.outputDir + + + + + + + + + + + +
DescriptionPath to the directory where generated files should be written to.
TypeString
+ + + + + + +### generate.llmTools + + + + + + + + + + + +
TypeOne of:Object
Array
RequiredNo
+ + + +### generate.llmTools.0 + + + + + + + +
TypeObject
+ + + +### generate.llmTools.0.outputFile + + + + + + + + + + + +
DescriptionPath where the JSON LLM tool definitions file should be generated.
TypeString
+ + + + + +### generate.llmTools.1 + + + + + + + +
TypeArray
+ + + +### generate.llmTools.1.outputFile + + + + + + + + + + + +
DescriptionPath where the JSON LLM tool definitions file should be generated.
TypeString
+ + + + + + + + + + + + +
+ +## Schema +``` +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "connector.yaml", + "additionalProperties": false, + "definitions": { + "javascriptSdk": { + "additionalProperties": true, + "type": "object", + "properties": { + "outputDir": { + "type": "string", + "description": "Path to the directory where generated files should be written to." + }, + "package": { + "type": "string", + "description": "The package name to use for the generated code." + }, + "packageJSONDir": { + "type": "string", + "description": "The directory containining the package.json to install the generated package in." + } + } + }, + "dartSdk": { + "additionalProperties": true, + "type": "object", + "properties": { + "outputDir": { + "type": "string", + "description": "Path to the directory where generated files should be written to." + }, + "package": { + "type": "string", + "description": "The package name to use for the generated code." + } + } + }, + "kotlinSdk": { + "additionalProperties": true, + "type": "object", + "properties": { + "outputDir": { + "type": "string", + "description": "Path to the directory where generated files should be written to." + }, + "package": { + "type": "string", + "description": "The package name to use for the generated code." + } + } + }, + "swiftSdk": { + "additionalProperties": true, + "type": "object", + "properties": { + "outputDir": { + "type": "string", + "description": "Path to the directory where generated files should be written to." + } + } + }, + "llmTools": { + "additionalProperties": true, + "type": "object", + "properties": { + "outputFile": { + "type": "string", + "description": "Path where the JSON LLM tool definitions file should be generated." + } + } + } + }, + "properties": { + "connectorId": { + "type": "string", + "description": "The ID of the Firebase Data Connect connector." + }, + "generate": { + "type": "object", + "additionalProperties": false, + "properties": { + "javascriptSdk": { + "oneOf": [ + { + "$ref": "#/definitions/javascriptSdk" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/javascriptSdk" + } + } + ], + "description": "Configuration for a generated Javascript SDK" + }, + "dartSdk": { + "oneOf": [ + { + "$ref": "#/definitions/dartSdk" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/dartSdk" + } + } + ], + "description": "Configuration for a generated Dart SDK" + }, + "kotlinSdk": { + "oneOf": [ + { + "$ref": "#/definitions/kotlinSdk" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/kotlinSdk" + } + } + ], + "description": "Configuration for a generated Kotlin SDK" + }, + "swiftSdk": { + "oneOf": [ + { + "$ref": "#/definitions/swiftSdk" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/swiftSdk" + } + } + ], + "description": "Configuration for a generated Swift SDK" + }, + "llmTools": { + "oneOf": [ + { + "$ref": "#/definitions/llmTools" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/llmTools" + } + } + ] + } + } + } + } +} +``` + + diff --git a/schema/docs/dataconnect-yaml.md b/schema/docs/dataconnect-yaml.md new file mode 100644 index 00000000000..5cd3899bb2a --- /dev/null +++ b/schema/docs/dataconnect-yaml.md @@ -0,0 +1,353 @@ + + +# + + + + + + + + +
$iddataconnect.yaml
$schemahttp://json-schema.org/draft-07/schema#
+ +## Properties + +
NameType
specVersionString
serviceIdString
locationString
connectorDirsArray
schemaObject
+ + + +
+ + +## specVersion + + + + + + + + + + + + + + + +
DescriptionThe Firebase Data Connect API version to target. If omitted, defaults to the latest version
TypeString
RequiredNo
+ + + + +## serviceId + + + + + + + + + + + + + + + +
DescriptionThe ID of the Firebase Data Connect service.
TypeString
RequiredNo
+ + + + +## location + + + + + + + + + + + + + + + +
DescriptionThe region of the Firebase Data Connect service.
TypeString
RequiredNo
+ + + + +## connectorDirs + + + + + + + + + + + + + + + +
DescriptionA list of directories containing conector.yaml files describing a connector to deploy.
TypeArray
RequiredNo
+ + + + +## schema + + + + + + + + + + + +
TypeObject
RequiredNo
+ +### Properties +
NameType
sourceString
datasourceOne of:Object
+ + +### schema.source + + + + + + + + + + + + + + + +
DescriptionRelative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema.
TypeString
RequiredNo
+ + + + +### schema.datasource + + + + + + + + + + + +
TypeOne of:Object
RequiredNo
+ + + +### schema.datasource.0 + + + + + + + +
TypeObject
+ + + +### schema.datasource.0.postgresql + + + + + + + +
TypeObject
+ + + +### schema.datasource.0.postgresql.database + + + + + + + + + + + +
DescriptionThe name of the PostgreSQL database.
TypeString
+ + + + +### schema.datasource.0.postgresql.cloudSql + + + + + + + +
TypeObject
+ + + +### schema.datasource.0.postgresql.cloudSql.instanceId + + + + + + + + + + + +
DescriptionThe ID of the CloudSQL instance for this database
TypeString
+ + + + +### schema.datasource.0.postgresql.cloudSql.schemaValidation + + + + + + + + + + + + + + +
DescriptionSchema validation mode for schema migrations
TypeString
Enum
  • COMPATIBLE
  • STRICT
+ + + + + + + + + + + + + + +
+ +## Schema +``` +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "dataconnect.yaml", + "additionalProperties": false, + "definitions": { + "postgresql": { + "additionalProperties": false, + "type": "object", + "properties": { + "database": { + "type": "string", + "description": "The name of the PostgreSQL database." + }, + "cloudSql": { + "additionalProperties": false, + "type": "object", + "properties": { + "instanceId": { + "type": "string", + "description": "The ID of the CloudSQL instance for this database" + }, + "schemaValidation": { + "type": "string", + "enum": [ + "COMPATIBLE", + "STRICT" + ], + "description": "Schema validation mode for schema migrations" + } + } + } + } + }, + "dataSource": { + "oneOf": [ + { + "additionalProperties": false, + "type": "object", + "properties": { + "postgresql": { + "$ref": "#/definitions/postgresql" + } + } + } + ] + }, + "schema": { + "additionalProperties": false, + "type": "object", + "properties": { + "source": { + "type": "string", + "description": "Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema." + }, + "datasource": { + "$ref": "#/definitions/dataSource" + } + } + } + }, + "properties": { + "specVersion": { + "type": "string", + "description": "The Firebase Data Connect API version to target. If omitted, defaults to the latest version" + }, + "serviceId": { + "type": "string", + "description": "The ID of the Firebase Data Connect service." + }, + "location": { + "type": "string", + "description": "The region of the Firebase Data Connect service." + }, + "connectorDirs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of directories containing conector.yaml files describing a connector to deploy." + }, + "schema": { + "$ref": "#/definitions/schema" + } + } +} +``` + + diff --git a/schema/docs/extension-yaml.md b/schema/docs/extension-yaml.md new file mode 100644 index 00000000000..818724f53ca --- /dev/null +++ b/schema/docs/extension-yaml.md @@ -0,0 +1,2011 @@ + + +# + + + + + + + + +
$idextension.yaml
$schemahttp://json-schema.org/draft-07/schema#
+ +## Properties + +
NameType
nameString
versionString
specVersionString
licenseString
displayNameString
descriptionString
iconString
billingRequiredBoolean
tagsArray
sourceUrlString
releaseNotesUrlString
authorObject
contributorsArray
apisArray
rolesArray
externalServicesArray
paramsArray
resourcesArray
lifecycleEventsArray
eventsArray
+ + + +
+ + +## name + + + + + + + + + + + + + + + +
DescriptionID of this extension (ie your-extension-name)
TypeString
RequiredNo
+ + + + +## version + + + + + + + + + + + + + + + +
DescriptionVersion of this extension. Follows https://semver.org/.
TypeString
RequiredNo
+ + + + +## specVersion + + + + + + + + + + + + + + + +
DescriptionVersion of the extension.yaml spec that this file follows. Currently always 'v1beta'
TypeString
RequiredNo
+ + + + +## license + + + + + + + + + + + + + + + +
DescriptionThe software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev
TypeString
RequiredNo
+ + + + +## displayName + + + + + + + + + + + + + + + +
DescriptionHuman readable name for this extension (ie 'Your Extension Name')
TypeString
RequiredNo
+ + + + +## description + + + + + + + + + + + + + + + +
DescriptionA one to two sentence description of what this extension does
TypeString
RequiredNo
+ + + + +## icon + + + + + + + + + + + + + + + +
DescriptionThe file name of this extension's icon
TypeString
RequiredNo
+ + + + +## billingRequired + + + + + + + + + + + + + + + +
DescriptionWhether this extension requires a billing to be enabled on the project it is installed on
TypeBoolean
RequiredNo
+ + + + +## tags + + + + + + + + + + + + + + + +
DescriptionA list of tags to help users find your extension in search
TypeArray
RequiredNo
+ + + + +## sourceUrl + + + + + + + + + + + + + + + +
DescriptionThe URL of the GitHub repo hosting this code
TypeString
RequiredNo
+ + + + +## releaseNotesUrl + + + + + + + + + + + + + + + +
DescriptionA URL where users can view the full changelog or release notes for this extension
TypeString
RequiredNo
+ + + + +## author + + + + + + + + + + + +
TypeObject
RequiredNo
+ +### Properties +
NameType
authorNameString
emailString
urlString
+ + +### author.authorName + + + + + + + + + + + + + + + +
DescriptionThe author's name
TypeString
RequiredNo
+ + + + +### author.email + + + + + + + + + + + + + + + +
DescriptionA contact email for the author
TypeString
RequiredNo
+ + + + +### author.url + + + + + + + + + + + + + + + +
DescriptionURL of the author's website
TypeString
RequiredNo
+ + + + + +## contributors + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + + +## apis + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + +### apis.apiName + + + + + + + + + + + + + + +
DescriptionName of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library
TypeString
Pattern[^\.]+\.googleapis\.com
+ + + + +### apis.reason + + + + + + + + + + + +
DescriptionWhy this extension needs this API enabled
TypeString
+ + + + + +## roles + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + +### roles.role + + + + + + + + + + + + + + +
DescriptionName of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles
TypeString
Pattern[a-zA-Z]+\.[a-zA-Z]+
+ + + + +### roles.reason + + + + + + + + + + + +
DescriptionWhy this extension needs this IAM role
TypeString
+ + + + +### roles.resource + + + + + + + + + + + +
DescriptionWhat resource to grant this role on. If omitted, defaults to projects/${project_id}
TypeString
+ + + + + +## externalServices + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + +### externalServices.name + + + + + + + + + + + +
DescriptionName of the external service
TypeString
+ + + + +### externalServices.pricingUri + + + + + + + + + + + +
DescriptionURI to pricing information for the service
TypeString
+ + + + + +## params + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + +### params.param + + + + + + + + + + + +
DescriptionThe name of the param. This is how you reference the param in your code
TypeString
+ + + + +### params.label + + + + + + + + + + + +
DescriptionShort description for the parameter. Displayed to users when they're prompted for the parameter's value.
TypeString
+ + + + +### params.description + + + + + + + + + + + +
DescriptionDetailed description for the parameter. Displayed to users when they're prompted for the parameter's value.
TypeString
+ + + + +### params.example + + + + + + + + + + + +
DescriptionExample value for the parameter.
TypeString
+ + + + +### params.validationRegex + + + + + + + + + + + +
DescriptionRegular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax.
TypeString
+ + + + +### params.validationErrorMessage + + + + + + + + + + + +
DescriptionError message to display if regex validation fails.
TypeString
+ + + + +### params.default + + + + + + + + + + + +
DescriptionDefault value for the parameter if the user leaves the parameter's value blank.
TypeString
+ + + + +### params.required + + + + + + + + + + + +
DescriptionDefines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true.
TypeBoolean
+ + + + +### params.immutable + + + + + + + + + + + +
DescriptionDefines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false.
TypeBoolean
+ + + + +### params.advanced + + + + + + + + + + + +
DescriptionWhether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param.
TypeBoolean
+ + + + +### params.type + + + + + + + + + + + + + + +
DescriptionThe parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details.
TypeString
Patternstring|select|multiSelect|secret|selectResource
+ + + + +### params.resourceType + + + + + + + + + + + + + + +
DescriptionThe type of resource to prompt the user to select. Provides a special UI treatment for the param.
TypeString
Patternstorage\.googleapis\.com\/Bucket|firestore\.googleapis\.com\/Database|firebasedatabase\.googleapis\.com\/DatabaseInstance
+ + + + +### params.options + + + + + + + + + + + +
DescriptionOptions for a select or multiSelect type param.
TypeArray
+ + + +### params.options.value + + + + + + + + + + + +
DescriptionOne of the values the user can choose. This is the value you get when you read the parameter value in code.
TypeString
+ + + + +### params.options.label + + + + + + + + + + + +
DescriptionShort description of the selectable option. If omitted, defaults to value.
TypeString
+ + + + + + +## resources + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + +### resources.name + + + + + + + + + + + +
DescriptionThe name of this resource
TypeString
+ + + + +### resources.type + + + + + + + + + + + +
DescriptionWhat type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options.
TypeString
+ + + + +### resources.description + + + + + + + + + + + +
DescriptionA brief description of what this resource does
TypeString
+ + + + +### resources.properties + + + + + + + + + + + +
DescriptionThe properties of this resource
TypeObject
+ + + +### resources.properties.location + + + + + + + + + + + +
DescriptionThe location for this resource
TypeString
+ + + + +### resources.properties.entryPoint + + + + + + + + + + + +
DescriptionThe entry point for a function resource
TypeString
+ + + + +### resources.properties.sourceDirectory + + + + + + + + + + + +
DescriptionDirectory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions
TypeString
+ + + + +### resources.properties.timeout + + + + + + + + + + + + + + +
DescriptionA function resources's maximum execution time.
TypeString
Pattern\d+s
+ + + + +### resources.properties.availableMemoryMb + + + + + + + + + + + + + + +
DescriptionAmount of memory in MB available for the function.
TypeString
Pattern\d+
+ + + + +### resources.properties.runtime + + + + + + + + + + + +
DescriptionRuntime environment for the function. Defaults to the most recent LTS version of node.
TypeString
+ + + + +### resources.properties.httpsTrigger + + + + + + + + + + + +
DescriptionA function triggered by HTTPS calls
TypeObject
+ + + + +### resources.properties.eventTrigger + + + + + + + + + + + +
DescriptionA function triggered by a background event
TypeObject
+ + + +### resources.properties.eventTrigger.eventType + + + + + + + + + + + +
DescriptionThe type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list.
TypeString
+ + + + +### resources.properties.eventTrigger.resource + + + + + + + + + + + +
DescriptionThe name or pattern of the resource to trigger on
TypeString
+ + + + +### resources.properties.eventTrigger.eventFilters + + + + + + + + + + + +
DescriptionFilters that further limit the events to listen to.
TypeArray
+ + + +### resources.properties.eventTrigger.eventFilters.attribute + + + + + + + + + + + +
DescriptionThe event attribute to filter on
TypeString
+ + + + +### resources.properties.eventTrigger.eventFilters.value + + + + + + + + + + + +
DescriptionThe value to filter for
TypeString
+ + + + + +### resources.properties.eventTrigger.channel + + + + + + + + + + + +
DescriptionThe name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel.
TypeString
+ + + + +### resources.properties.eventTrigger.triggerRegion + + + + + + + + + + + +
DescriptionThe trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
TypeString
+ + + + + +### resources.properties.scheduleTrigger + + + + + + + + + + + +
DescriptionA function triggered at a regular interval by a Cloud Scheduler job
TypeObject
+ + + +### resources.properties.scheduleTrigger.schedule + + + + + + + + + + + +
DescriptionThe frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax.
TypeString
+ + + + +### resources.properties.scheduleTrigger.timeZone + + + + + + + + + + + +
DescriptionThe time zone in which the schedule will run. Defaults to UTC.
TypeString
+ + + + + +### resources.properties.taskQueueTrigger + + + + + + + + + + + +
DescriptionA function triggered by a Cloud Task
TypeObject
+ + + + +### resources.properties.buildConfig + + + + + + + + + + + +
DescriptionBuild configuration for a gen 2 Cloud Function
TypeObject
+ + + +### resources.properties.buildConfig.runtime + + + + + + + + + + + +
DescriptionRuntime environment for the function. Defaults to the most recent LTS version of node.
TypeString
+ + + + +### resources.properties.buildConfig.entryPoint + + + + + + + + + + + +
DescriptionThe entry point for a function resource
TypeString
+ + + + + +### resources.properties.serviceConfig + + + + + + + + + + + +
DescriptionService configuration for a gen 2 Cloud Function
TypeObject
+ + + +### resources.properties.serviceConfig.timeoutSeconds + + + + + + + + + + + +
DescriptionThe function's maximum execution time. Default: 60, max value: 540.
TypeString
+ + + + +### resources.properties.serviceConfig.availableMemory + + + + + + + + + + + +
DescriptionThe amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes.
TypeString
+ + + + + + + +## lifecycleEvents + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + +### lifecycleEvents.onInstall + + + + + + + +
TypeObject
+ + + +### lifecycleEvents.onInstall.function + + + + + + + + + + + +
DescriptionName of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section.
TypeString
+ + + + +### lifecycleEvents.onInstall.processingMessage + + + + + + + + + + + +
DescriptionMessage to display in the Firebase console while the task is in progress.
TypeString
+ + + + + +### lifecycleEvents.onUpdate + + + + + + + +
TypeObject
+ + + +### lifecycleEvents.onUpdate.function + + + + + + + + + + + +
DescriptionName of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section.
TypeString
+ + + + +### lifecycleEvents.onUpdate.processingMessage + + + + + + + + + + + +
DescriptionMessage to display in the Firebase console while the task is in progress.
TypeString
+ + + + + +### lifecycleEvents.onConfigure + + + + + + + +
TypeObject
+ + + +### lifecycleEvents.onConfigure.function + + + + + + + + + + + +
DescriptionName of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section.
TypeString
+ + + + +### lifecycleEvents.onConfigure.processingMessage + + + + + + + + + + + +
DescriptionMessage to display in the Firebase console while the task is in progress.
TypeString
+ + + + + + +## events + + + + + + + + + + + +
TypeArray
RequiredNo
+ + + +### events.type + + + + + + + + + + + +
DescriptionThe type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish.
TypeString
+ + + + +### events.description + + + + + + + + + + + +
DescriptionA description of the event
TypeString
+ + + + + + + + + + +
+ +## Schema +``` +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "extension.yaml", + "additionalProperties": false, + "definitions": { + "author": { + "additionalProperties": false, + "type": "object", + "properties": { + "authorName": { + "type": "string", + "description": "The author's name" + }, + "email": { + "type": "string", + "description": "A contact email for the author" + }, + "url": { + "type": "string", + "description": "URL of the author's website" + } + } + }, + "role": { + "additionalProperties": false, + "type": "object", + "description": "An IAM role to grant to this extension.", + "properties": { + "role": { + "type": "string", + "description": "Name of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles", + "pattern": "[a-zA-Z]+\\.[a-zA-Z]+" + }, + "reason": { + "type": "string", + "description": "Why this extension needs this IAM role" + }, + "resource": { + "type": "string", + "description": "What resource to grant this role on. If omitted, defaults to projects/${project_id}" + } + }, + "required": [ + "role", + "reason" + ] + }, + "api": { + "additionalProperties": false, + "type": "object", + "description": "A Google API used by this extension. Will be enabled on extension deployment.", + "properties": { + "apiName": { + "type": "string", + "description": "Name of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library", + "pattern": "[^\\.]+\\.googleapis\\.com" + }, + "reason": { + "type": "string", + "description": "Why this extension needs this API enabled" + } + }, + "required": [ + "apiName", + "reason" + ] + }, + "externalService": { + "additionalProperties": false, + "type": "object", + "description": "A non-Google API used by this extension", + "properties": { + "name": { + "type": "string", + "description": "Name of the external service" + }, + "pricingUri": { + "type": "string", + "description": "URI to pricing information for the service" + } + } + }, + "param": { + "additionalProperties": false, + "type": "object", + "description": "A parameter that users installing this extension can configure", + "properties": { + "param": { + "type": "string", + "description": "The name of the param. This is how you reference the param in your code" + }, + "label": { + "type": "string", + "description": "Short description for the parameter. Displayed to users when they're prompted for the parameter's value." + }, + "description": { + "type": "string", + "description": "Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value." + }, + "example": { + "type": "string", + "description": "Example value for the parameter." + }, + "validationRegex": { + "type": "string", + "description": "Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax." + }, + "validationErrorMessage": { + "type": "string", + "description": "Error message to display if regex validation fails." + }, + "default": { + "type": "string", + "description": "Default value for the parameter if the user leaves the parameter's value blank." + }, + "required": { + "type": "boolean", + "description": "Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true." + }, + "immutable": { + "type": "boolean", + "description": "Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false." + }, + "advanced": { + "type": "boolean", + "description": "Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param." + }, + "type": { + "type": "string", + "description": "The parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details.", + "pattern": "string|select|multiSelect|secret|selectResource" + }, + "resourceType": { + "type": "string", + "description": "The type of resource to prompt the user to select. Provides a special UI treatment for the param.", + "pattern": "storage\\.googleapis\\.com\\/Bucket|firestore\\.googleapis\\.com\\/Database|firebasedatabase\\.googleapis\\.com\\/DatabaseInstance" + }, + "options": { + "type": "array", + "description": "Options for a select or multiSelect type param.", + "items": { + "$ref": "#/definitions/paramOption" + } + } + }, + "required": [ + "param" + ] + }, + "paramOption": { + "additionalProperties": false, + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "One of the values the user can choose. This is the value you get when you read the parameter value in code." + }, + "label": { + "type": "string", + "description": "Short description of the selectable option. If omitted, defaults to value." + } + }, + "required": [ + "value" + ] + }, + "resource": { + "additionalProperties": false, + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of this resource" + }, + "type": { + "type": "string", + "description": "What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options." + }, + "description": { + "type": "string", + "description": "A brief description of what this resource does" + }, + "properties": { + "type": "object", + "description": "The properties of this resource", + "additionalProperties": true, + "properties": { + "location": { + "type": "string", + "description": "The location for this resource" + }, + "entryPoint": { + "type": "string", + "description": "The entry point for a function resource" + }, + "sourceDirectory": { + "type": "string", + "description": "Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions" + }, + "timeout": { + "type": "string", + "description": "A function resources's maximum execution time.", + "pattern": "\\d+s" + }, + "availableMemoryMb": { + "type": "string", + "description": "Amount of memory in MB available for the function.", + "pattern": "\\d+" + }, + "runtime": { + "type": "string", + "description": "Runtime environment for the function. Defaults to the most recent LTS version of node." + }, + "httpsTrigger": { + "type": "object", + "description": "A function triggered by HTTPS calls", + "properties": {} + }, + "eventTrigger": { + "type": "object", + "description": "A function triggered by a background event", + "properties": { + "eventType": { + "type": "string", + "description": "The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list." + }, + "resource": { + "type": "string", + "description": "The name or pattern of the resource to trigger on" + }, + "eventFilters": { + "type": "array", + "description": "Filters that further limit the events to listen to.", + "items": { + "$ref": "#/definitions/eventFilter" + } + }, + "channel": { + "type": "string", + "description": "The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel." + }, + "triggerRegion": { + "type": "string", + "description": "The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function." + } + }, + "required": [ + "eventType" + ] + }, + "scheduleTrigger": { + "type": "object", + "description": "A function triggered at a regular interval by a Cloud Scheduler job", + "properties": { + "schedule": { + "type": "string", + "description": "The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax." + }, + "timeZone": { + "type": "string", + "description": "The time zone in which the schedule will run. Defaults to UTC." + } + }, + "required": [ + "schedule" + ] + }, + "taskQueueTrigger": { + "type": "object", + "description": "A function triggered by a Cloud Task", + "properties": {} + }, + "buildConfig": { + "type": "object", + "description": "Build configuration for a gen 2 Cloud Function", + "properties": { + "runtime": { + "type": "string", + "description": "Runtime environment for the function. Defaults to the most recent LTS version of node." + }, + "entryPoint": { + "type": "string", + "description": "The entry point for a function resource" + } + } + }, + "serviceConfig": { + "type": "object", + "description": "Service configuration for a gen 2 Cloud Function", + "properties": { + "timeoutSeconds": { + "type": "string", + "description": "The function's maximum execution time. Default: 60, max value: 540." + }, + "availableMemory": { + "type": "string", + "description": "The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes." + } + } + } + } + } + }, + "required": [ + "name", + "type", + "description", + "properties" + ] + }, + "lifecycleEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "onInstall": { + "$ref": "#/definitions/lifecycleEventSpec" + }, + "onUpdate": { + "$ref": "#/definitions/lifecycleEventSpec" + }, + "onConfigure": { + "$ref": "#/definitions/lifecycleEventSpec" + } + } + }, + "lifecycleEventSpec": { + "type": "object", + "additionalProperties": false, + "properties": { + "function": { + "type": "string", + "description": "Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section." + }, + "processingMessage": { + "type": "string", + "description": "Message to display in the Firebase console while the task is in progress." + } + } + }, + "event": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish." + }, + "description": { + "type": "string", + "description": "A description of the event" + } + } + }, + "eventFilter": { + "type": "object", + "properties": { + "attribute": { + "type": "string", + "description": "The event attribute to filter on" + }, + "value": { + "type": "string", + "description": "The value to filter for" + } + } + } + }, + "properties": { + "name": { + "type": "string", + "description": "ID of this extension (ie your-extension-name)" + }, + "version": { + "type": "string", + "description": "Version of this extension. Follows https://semver.org/." + }, + "specVersion": { + "type": "string", + "description": "Version of the extension.yaml spec that this file follows. Currently always 'v1beta'" + }, + "license": { + "type": "string", + "description": "The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev" + }, + "displayName": { + "type": "string", + "description": "Human readable name for this extension (ie 'Your Extension Name')" + }, + "description": { + "type": "string", + "description": "A one to two sentence description of what this extension does" + }, + "icon": { + "type": "string", + "description": "The file name of this extension's icon" + }, + "billingRequired": { + "type": "boolean", + "description": "Whether this extension requires a billing to be enabled on the project it is installed on" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tags to help users find your extension in search" + }, + "sourceUrl": { + "type": "string", + "description": "The URL of the GitHub repo hosting this code" + }, + "releaseNotesUrl": { + "type": "string", + "description": "A URL where users can view the full changelog or release notes for this extension" + }, + "author": { + "$ref": "#/definitions/author" + }, + "contributors": { + "type": "array", + "items": { + "$ref": "#/definitions/author" + } + }, + "apis": { + "type": "array", + "items": { + "$ref": "#/definitions/api" + } + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/role" + } + }, + "externalServices": { + "type": "array", + "items": { + "$ref": "#/definitions/externalService" + } + }, + "params": { + "type": "array", + "items": { + "$ref": "#/definitions/param" + } + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/resource" + } + }, + "lifecycleEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/lifecycleEvent" + } + }, + "events": { + "type": "array", + "items": { + "$ref": "#/definitions/event" + } + } + } +} +``` + + diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md new file mode 100644 index 00000000000..2979cb07fd8 --- /dev/null +++ b/schema/docs/firebase-config.md @@ -0,0 +1,4764 @@ + + +# + + + + + + + + +
$idfirebase.json
$schemahttp://json-schema.org/draft-07/schema#
+ +## Properties + +
NameType
$schemaString
apphostingAny of:Object
Array
databaseAny of:Object
Array
dataconnectAny of:Object
Array
emulatorsObject
extensionsObject
firestoreAny of:Object
Array
functionsAny of:Object
Array
hostingAny of:Object
Array
remoteconfigObject
storageAny of:Object
Array
+ + + +
+ + +## $schema + + + + + + + + + + + + + + +
TypeString
RequiredNo
Formaturi
+ + + + +## apphosting + + + + + + + + + + + +
TypeAny of:Object
Array
RequiredNo
+ + + +### apphosting.0 + + + + + + + +
TypeObject
+ + + +### apphosting.0.alwaysDeployFromSource + + + + + + + +
TypeBoolean
+ + + + +### apphosting.0.backendId + + + + + + + +
TypeString
+ + + + +### apphosting.0.ignore + + + + + + + +
TypeArray
+ + + + +### apphosting.0.rootDir + + + + + + + +
TypeString
+ + + + + +### apphosting.1 + + + + + + + +
TypeArray
+ + + +### apphosting.1.alwaysDeployFromSource + + + + + + + +
TypeBoolean
+ + + + +### apphosting.1.backendId + + + + + + + +
TypeString
+ + + + +### apphosting.1.ignore + + + + + + + +
TypeArray
+ + + + +### apphosting.1.rootDir + + + + + + + +
TypeString
+ + + + + + +## database + + + + + + + + + + + +
TypeAny of:Object
Array
RequiredNo
+ + + +### database.0 + + + + + + + +
TypeObject
+ + + +### database.0.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### database.0.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### database.0.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### database.0.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### database.0.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### database.0.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### database.0.rules + + + + + + + +
TypeString
+ + + + + +### database.1 + + + + + + + +
TypeArray
+ + + + + +## dataconnect + + + + + + + + + + + +
TypeAny of:Object
Array
RequiredNo
+ + + +### dataconnect.0 + + + + + + + +
TypeObject
+ + + +### dataconnect.0.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### dataconnect.0.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### dataconnect.0.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### dataconnect.0.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### dataconnect.0.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### dataconnect.0.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### dataconnect.0.source + + + + + + + +
TypeString
+ + + + + +### dataconnect.1 + + + + + + + +
TypeArray
+ + + +### dataconnect.1.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### dataconnect.1.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### dataconnect.1.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### dataconnect.1.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### dataconnect.1.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### dataconnect.1.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### dataconnect.1.source + + + + + + + +
TypeString
+ + + + + + +## emulators + + + + + + + + + + + +
TypeObject
RequiredNo
+ +### Properties +
NameType
apphostingObject
authObject
databaseObject
dataconnectObject
eventarcObject
extensionsObject
firestoreObject
functionsObject
hostingObject
hubObject
loggingObject
pubsubObject
singleProjectModeBoolean
storageObject
tasksObject
uiObject
+ + +### emulators.apphosting + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.apphosting.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.apphosting.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + +### emulators.apphosting.rootDirectory + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.apphosting.startCommand + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.apphosting.startCommandOverride + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + + +### emulators.auth + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.auth.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.auth.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.database + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.database.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.database.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.dataconnect + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.dataconnect.dataDir + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.dataconnect.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.dataconnect.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + +### emulators.dataconnect.postgresHost + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.dataconnect.postgresPort + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.eventarc + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.eventarc.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.eventarc.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.extensions + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + + +### emulators.firestore + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.firestore.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.firestore.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + +### emulators.firestore.websocketPort + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.functions + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.functions.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.functions.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.hosting + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.hosting.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.hosting.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.hub + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.hub.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.hub.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.logging + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.logging.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.logging.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.pubsub + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.pubsub.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.pubsub.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.singleProjectMode + + + + + + + + + + + +
TypeBoolean
RequiredNo
+ + + + +### emulators.storage + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.storage.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.storage.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.tasks + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.tasks.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.tasks.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + +### emulators.ui + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + +### emulators.ui.enabled + + + + + + + + + + + +
TypeBoolean
RequiredNo
+ + + + +### emulators.ui.host + + + + + + + + + + + +
TypeString
RequiredNo
+ + + + +### emulators.ui.port + + + + + + + + + + + +
TypeNumber
RequiredNo
+ + + + + + +## extensions + + + + + + + + + + + +
TypeObject
RequiredNo
+ + + + +## firestore + + + + + + + + + + + +
TypeAny of:Object
Array
RequiredNo
+ + + +### firestore.0 + + + + + + + +
TypeObject
+ + + +### firestore.0.database + + + + + + + +
TypeString
+ + + + +### firestore.0.indexes + + + + + + + +
TypeString
+ + + + +### firestore.0.location + + + + + + + +
TypeString
+ + + + +### firestore.0.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### firestore.0.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### firestore.0.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### firestore.0.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### firestore.0.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### firestore.0.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### firestore.0.rules + + + + + + + +
TypeString
+ + + + + +### firestore.1 + + + + + + + +
TypeArray
+ + + + + +## functions + + + + + + + + + + + +
TypeAny of:Object
Array
RequiredNo
+ + + +### functions.0 + + + + + + + +
TypeObject
+ + + +### functions.0.codebase + + + + + + + +
TypeString
+ + + + +### functions.0.ignore + + + + + + + +
TypeArray
+ + + + +### functions.0.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### functions.0.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### functions.0.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### functions.0.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### functions.0.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### functions.0.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### functions.0.runtime + + + + + + + + + + +
TypeString
Enum
  • nodejs20
  • nodejs22
  • python310
  • python311
  • python312
  • python313
+ + + + +### functions.0.source + + + + + + + +
TypeString
+ + + + + +### functions.1 + + + + + + + +
TypeArray
+ + + +### functions.1.codebase + + + + + + + +
TypeString
+ + + + +### functions.1.ignore + + + + + + + +
TypeArray
+ + + + +### functions.1.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### functions.1.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### functions.1.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### functions.1.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### functions.1.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### functions.1.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### functions.1.runtime + + + + + + + + + + +
TypeString
Enum
  • nodejs20
  • nodejs22
  • python310
  • python311
  • python312
  • python313
+ + + + +### functions.1.source + + + + + + + +
TypeString
+ + + + + + +## hosting + + + + + + + + + + + +
TypeAny of:Object
Array
RequiredNo
+ + + +### hosting.0 + + + + + + + +
TypeObject
+ + + +### hosting.0.appAssociation + + + + + + + + + + +
TypeString
Enum
  • AUTO
  • NONE
+ + + + +### hosting.0.cleanUrls + + + + + + + +
TypeBoolean
+ + + + +### hosting.0.frameworksBackend + + + + + + + +
TypeObject
+ + + +### hosting.0.frameworksBackend.concurrency + + + + + + + + + + + +
DescriptionNumber of requests a function can serve at once.
TypeNumber
+ + + + +### hosting.0.frameworksBackend.cors + + + + + + + + + + + +
DescriptionIf true, allows CORS on requests to this function. +If this is a `string` or `RegExp`, allows requests from domains that match the provided value. +If this is an `Array`, allows requests from domains matching at least one entry of the array. +Defaults to true for {@link https.CallableFunction} and false otherwise.
Type[string, boolean]
+ + + + +### hosting.0.frameworksBackend.cpu + + + + + + + + + + + +
DescriptionFractional number of CPUs to allocate to a function.
TypeAny of:String
Number
+ + + +### hosting.0.frameworksBackend.cpu.0 + + + + + + + + + + +
TypeString
Constgcf_gen1
+ + + + +### hosting.0.frameworksBackend.cpu.1 + + + + + + + +
TypeNumber
+ + + + + +### hosting.0.frameworksBackend.enforceAppCheck + + + + + + + + + + + +
DescriptionDetermines whether Firebase AppCheck is enforced. Defaults to false.
TypeBoolean
+ + + + +### hosting.0.frameworksBackend.ingressSettings + + + + + + + + + + + + + + +
DescriptionIngress settings which control where this function can be called from.
TypeString
Enum
  • ALLOW_ALL
  • ALLOW_INTERNAL_AND_GCLB
  • ALLOW_INTERNAL_ONLY
+ + + + +### hosting.0.frameworksBackend.invoker + + + + + + + + + + + + + + +
DescriptionInvoker to set access control on https functions.
TypeString
Constpublic
+ + + + +### hosting.0.frameworksBackend.labels + + + + + + + + + + + +
DescriptionUser labels to set on the function.
TypeObject
+ + + + +### hosting.0.frameworksBackend.maxInstances + + + + + + + + + + + +
DescriptionMax number of instances to be running in parallel.
TypeNumber
+ + + + +### hosting.0.frameworksBackend.memory + + + + + + + + + + + + + + +
DescriptionAmount of memory to allocate to a function.
TypeString
Enum
  • 128MiB
  • 16GiB
  • 1GiB
  • 256MiB
  • 2GiB
  • 32GiB
  • 4GiB
  • 512MiB
  • 8GiB
+ + + + +### hosting.0.frameworksBackend.minInstances + + + + + + + + + + + +
DescriptionMin number of actual instances to be running at a given time.
TypeNumber
+ + + + +### hosting.0.frameworksBackend.omit + + + + + + + + + + + +
DescriptionIf true, do not deploy or emulate this function.
TypeBoolean
+ + + + +### hosting.0.frameworksBackend.preserveExternalChanges + + + + + + + + + + + +
DescriptionControls whether function configuration modified outside of function source is preserved. Defaults to false.
TypeBoolean
+ + + + +### hosting.0.frameworksBackend.region + + + + + + + + + + + +
DescriptionHTTP functions can override global options and can specify multiple regions to deploy to.
TypeString
+ + + + +### hosting.0.frameworksBackend.secrets + + + + + + + +
TypeArray
+ + + + +### hosting.0.frameworksBackend.serviceAccount + + + + + + + + + + + +
DescriptionSpecific service account for the function to run as.
TypeString
+ + + + +### hosting.0.frameworksBackend.timeoutSeconds + + + + + + + + + + + +
DescriptionTimeout for the function in seconds, possible values are 0 to 540. +HTTPS functions can specify a higher timeout.
TypeNumber
+ + + + +### hosting.0.frameworksBackend.vpcConnector + + + + + + + + + + + +
DescriptionConnect cloud function to specified VPC connector.
TypeString
+ + + + +### hosting.0.frameworksBackend.vpcConnectorEgressSettings + + + + + + + + + + + + + + +
DescriptionEgress settings for VPC connector.
TypeString
Enum
  • ALL_TRAFFIC
  • PRIVATE_RANGES_ONLY
+ + + + + +### hosting.0.headers + + + + + + + +
TypeArray
+ + + + +### hosting.0.i18n + + + + + + + +
TypeObject
+ + + +### hosting.0.i18n.root + + + + + + + +
TypeString
+ + + + + +### hosting.0.ignore + + + + + + + +
TypeArray
+ + + + +### hosting.0.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### hosting.0.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### hosting.0.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### hosting.0.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### hosting.0.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### hosting.0.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### hosting.0.public + + + + + + + +
TypeString
+ + + + +### hosting.0.redirects + + + + + + + +
TypeArray
+ + + + +### hosting.0.rewrites + + + + + + + +
TypeArray
+ + + + +### hosting.0.site + + + + + + + +
TypeString
+ + + + +### hosting.0.source + + + + + + + +
TypeString
+ + + + +### hosting.0.target + + + + + + + +
TypeString
+ + + + +### hosting.0.trailingSlash + + + + + + + +
TypeBoolean
+ + + + + +### hosting.1 + + + + + + + +
TypeArray
+ + + + + +## remoteconfig + + + + + + + + + + + +
TypeObject
RequiredNo
+ +### Properties +
NameType
postdeployAny of:Array
String
predeployAny of:Array
String
templateString
+ + +### remoteconfig.postdeploy + + + + + + + + + + + +
TypeAny of:Array
String
RequiredNo
+ + + +### remoteconfig.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### remoteconfig.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### remoteconfig.predeploy + + + + + + + + + + + +
TypeAny of:Array
String
RequiredNo
+ + + +### remoteconfig.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### remoteconfig.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### remoteconfig.template + + + + + + + + + + + +
TypeString
RequiredYes
+ + + + + +## storage + + + + + + + + + + + +
TypeAny of:Object
Array
RequiredNo
+ + + +### storage.0 + + + + + + + +
TypeObject
+ + + +### storage.0.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### storage.0.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### storage.0.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### storage.0.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### storage.0.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### storage.0.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### storage.0.rules + + + + + + + +
TypeString
+ + + + +### storage.0.target + + + + + + + +
TypeString
+ + + + + +### storage.1 + + + + + + + +
TypeArray
+ + + +### storage.1.bucket + + + + + + + +
TypeString
+ + + + +### storage.1.postdeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### storage.1.postdeploy.0 + + + + + + + +
TypeArray
+ + + + +### storage.1.postdeploy.1 + + + + + + + +
TypeString
+ + + + + +### storage.1.predeploy + + + + + + + +
TypeAny of:Array
String
+ + + +### storage.1.predeploy.0 + + + + + + + +
TypeArray
+ + + + +### storage.1.predeploy.1 + + + + + + + +
TypeString
+ + + + + +### storage.1.rules + + + + + + + +
TypeString
+ + + + +### storage.1.target + + + + + + + +
TypeString
+ + + + + + + + + + + +
+ +## Schema +``` +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "firebase.json", + "additionalProperties": false, + "definitions": { + "DataConnectSingle": { + "additionalProperties": false, + "properties": { + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "source": { + "type": "string" + } + }, + "required": [ + "source" + ], + "type": "object" + }, + "DatabaseSingle": { + "additionalProperties": false, + "properties": { + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + } + }, + "required": [ + "rules" + ], + "type": "object" + }, + "ExtensionsConfig": { + "additionalProperties": false, + "type": "object" + }, + "FirestoreSingle": { + "additionalProperties": false, + "properties": { + "database": { + "type": "string" + }, + "indexes": { + "type": "string" + }, + "location": { + "type": "string" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + } + }, + "type": "object" + }, + "FrameworksBackendOptions": { + "additionalProperties": false, + "properties": { + "concurrency": { + "description": "Number of requests a function can serve at once.", + "type": "number" + }, + "cors": { + "description": "If true, allows CORS on requests to this function.\nIf this is a `string` or `RegExp`, allows requests from domains that match the provided value.\nIf this is an `Array`, allows requests from domains matching at least one entry of the array.\nDefaults to true for {@link https.CallableFunction} and false otherwise.", + "type": [ + "string", + "boolean" + ] + }, + "cpu": { + "anyOf": [ + { + "const": "gcf_gen1", + "type": "string" + }, + { + "type": "number" + } + ], + "description": "Fractional number of CPUs to allocate to a function." + }, + "enforceAppCheck": { + "description": "Determines whether Firebase AppCheck is enforced. Defaults to false.", + "type": "boolean" + }, + "ingressSettings": { + "description": "Ingress settings which control where this function can be called from.", + "enum": [ + "ALLOW_ALL", + "ALLOW_INTERNAL_AND_GCLB", + "ALLOW_INTERNAL_ONLY" + ], + "type": "string" + }, + "invoker": { + "const": "public", + "description": "Invoker to set access control on https functions.", + "type": "string" + }, + "labels": { + "$ref": "#/definitions/Record", + "description": "User labels to set on the function." + }, + "maxInstances": { + "description": "Max number of instances to be running in parallel.", + "type": "number" + }, + "memory": { + "description": "Amount of memory to allocate to a function.", + "enum": [ + "128MiB", + "16GiB", + "1GiB", + "256MiB", + "2GiB", + "32GiB", + "4GiB", + "512MiB", + "8GiB" + ], + "type": "string" + }, + "minInstances": { + "description": "Min number of actual instances to be running at a given time.", + "type": "number" + }, + "omit": { + "description": "If true, do not deploy or emulate this function.", + "type": "boolean" + }, + "preserveExternalChanges": { + "description": "Controls whether function configuration modified outside of function source is preserved. Defaults to false.", + "type": "boolean" + }, + "region": { + "description": "HTTP functions can override global options and can specify multiple regions to deploy to.", + "type": "string" + }, + "secrets": { + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceAccount": { + "description": "Specific service account for the function to run as.", + "type": "string" + }, + "timeoutSeconds": { + "description": "Timeout for the function in seconds, possible values are 0 to 540.\nHTTPS functions can specify a higher timeout.", + "type": "number" + }, + "vpcConnector": { + "description": "Connect cloud function to specified VPC connector.", + "type": "string" + }, + "vpcConnectorEgressSettings": { + "description": "Egress settings for VPC connector.", + "enum": [ + "ALL_TRAFFIC", + "PRIVATE_RANGES_ONLY" + ], + "type": "string" + } + }, + "type": "object" + }, + "FunctionConfig": { + "additionalProperties": false, + "properties": { + "codebase": { + "type": "string" + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "runtime": { + "enum": [ + "nodejs20", + "nodejs22", + "python310", + "python311", + "python312", + "python313" + ], + "type": "string" + }, + "source": { + "type": "string" + } + }, + "type": "object" + }, + "HostingHeaders": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "glob": { + "type": "string" + }, + "headers": { + "items": { + "additionalProperties": false, + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "glob", + "headers" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "headers": { + "items": { + "additionalProperties": false, + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "source": { + "type": "string" + } + }, + "required": [ + "headers", + "source" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "headers": { + "items": { + "additionalProperties": false, + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "regex": { + "type": "string" + } + }, + "required": [ + "headers", + "regex" + ], + "type": "object" + } + ] + }, + "HostingRedirects": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "destination": { + "type": "string" + }, + "glob": { + "type": "string" + }, + "type": { + "type": "number" + } + }, + "required": [ + "destination", + "glob" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "destination": { + "type": "string" + }, + "source": { + "type": "string" + }, + "type": { + "type": "number" + } + }, + "required": [ + "destination", + "source" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "destination": { + "type": "string" + }, + "regex": { + "type": "string" + }, + "type": { + "type": "number" + } + }, + "required": [ + "destination", + "regex" + ], + "type": "object" + } + ] + }, + "HostingRewrites": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "destination": { + "type": "string" + }, + "glob": { + "type": "string" + } + }, + "required": [ + "destination", + "glob" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "function": { + "type": "string" + }, + "glob": { + "type": "string" + }, + "region": { + "type": "string" + } + }, + "required": [ + "function", + "glob" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "function": { + "additionalProperties": false, + "properties": { + "functionId": { + "type": "string" + }, + "pinTag": { + "type": "boolean" + }, + "region": { + "type": "string" + } + }, + "required": [ + "functionId" + ], + "type": "object" + }, + "glob": { + "type": "string" + } + }, + "required": [ + "function", + "glob" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "glob": { + "type": "string" + }, + "run": { + "additionalProperties": false, + "properties": { + "pinTag": { + "type": "boolean" + }, + "region": { + "type": "string" + }, + "serviceId": { + "type": "string" + } + }, + "required": [ + "serviceId" + ], + "type": "object" + } + }, + "required": [ + "glob", + "run" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "dynamicLinks": { + "type": "boolean" + }, + "glob": { + "type": "string" + } + }, + "required": [ + "dynamicLinks", + "glob" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "destination": { + "type": "string" + }, + "source": { + "type": "string" + } + }, + "required": [ + "destination", + "source" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "function": { + "type": "string" + }, + "region": { + "type": "string" + }, + "source": { + "type": "string" + } + }, + "required": [ + "function", + "source" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "function": { + "additionalProperties": false, + "properties": { + "functionId": { + "type": "string" + }, + "pinTag": { + "type": "boolean" + }, + "region": { + "type": "string" + } + }, + "required": [ + "functionId" + ], + "type": "object" + }, + "source": { + "type": "string" + } + }, + "required": [ + "function", + "source" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "run": { + "additionalProperties": false, + "properties": { + "pinTag": { + "type": "boolean" + }, + "region": { + "type": "string" + }, + "serviceId": { + "type": "string" + } + }, + "required": [ + "serviceId" + ], + "type": "object" + }, + "source": { + "type": "string" + } + }, + "required": [ + "run", + "source" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "dynamicLinks": { + "type": "boolean" + }, + "source": { + "type": "string" + } + }, + "required": [ + "dynamicLinks", + "source" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "destination": { + "type": "string" + }, + "regex": { + "type": "string" + } + }, + "required": [ + "destination", + "regex" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "function": { + "type": "string" + }, + "regex": { + "type": "string" + }, + "region": { + "type": "string" + } + }, + "required": [ + "function", + "regex" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "function": { + "additionalProperties": false, + "properties": { + "functionId": { + "type": "string" + }, + "pinTag": { + "type": "boolean" + }, + "region": { + "type": "string" + } + }, + "required": [ + "functionId" + ], + "type": "object" + }, + "regex": { + "type": "string" + } + }, + "required": [ + "function", + "regex" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "regex": { + "type": "string" + }, + "run": { + "additionalProperties": false, + "properties": { + "pinTag": { + "type": "boolean" + }, + "region": { + "type": "string" + }, + "serviceId": { + "type": "string" + } + }, + "required": [ + "serviceId" + ], + "type": "object" + } + }, + "required": [ + "regex", + "run" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "dynamicLinks": { + "type": "boolean" + }, + "regex": { + "type": "string" + } + }, + "required": [ + "dynamicLinks", + "regex" + ], + "type": "object" + } + ] + }, + "HostingSingle": { + "additionalProperties": false, + "properties": { + "appAssociation": { + "enum": [ + "AUTO", + "NONE" + ], + "type": "string" + }, + "cleanUrls": { + "type": "boolean" + }, + "frameworksBackend": { + "$ref": "#/definitions/FrameworksBackendOptions" + }, + "headers": { + "items": { + "$ref": "#/definitions/HostingHeaders" + }, + "type": "array" + }, + "i18n": { + "additionalProperties": false, + "properties": { + "root": { + "type": "string" + } + }, + "required": [ + "root" + ], + "type": "object" + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "public": { + "type": "string" + }, + "redirects": { + "items": { + "$ref": "#/definitions/HostingRedirects" + }, + "type": "array" + }, + "rewrites": { + "items": { + "$ref": "#/definitions/HostingRewrites" + }, + "type": "array" + }, + "site": { + "type": "string" + }, + "source": { + "type": "string" + }, + "target": { + "type": "string" + }, + "trailingSlash": { + "type": "boolean" + } + }, + "type": "object" + }, + "Record": { + "additionalProperties": false, + "type": "object" + }, + "RemoteConfigConfig": { + "additionalProperties": false, + "properties": { + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "template": { + "type": "string" + } + }, + "required": [ + "template" + ], + "type": "object" + }, + "StorageSingle": { + "additionalProperties": false, + "properties": { + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + }, + "target": { + "type": "string" + } + }, + "required": [ + "rules" + ], + "type": "object" + } + }, + "properties": { + "$schema": { + "format": "uri", + "type": "string" + }, + "apphosting": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "alwaysDeployFromSource": { + "type": "boolean" + }, + "backendId": { + "type": "string" + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array" + }, + "rootDir": { + "type": "string" + } + }, + "required": [ + "backendId", + "ignore", + "rootDir" + ], + "type": "object" + }, + { + "items": { + "additionalProperties": false, + "properties": { + "alwaysDeployFromSource": { + "type": "boolean" + }, + "backendId": { + "type": "string" + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array" + }, + "rootDir": { + "type": "string" + } + }, + "required": [ + "backendId", + "ignore", + "rootDir" + ], + "type": "object" + }, + "type": "array" + } + ] + }, + "database": { + "anyOf": [ + { + "$ref": "#/definitions/DatabaseSingle" + }, + { + "items": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "instance": { + "type": "string" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + }, + "target": { + "type": "string" + } + }, + "required": [ + "instance", + "rules" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "instance": { + "type": "string" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + }, + "target": { + "type": "string" + } + }, + "required": [ + "rules", + "target" + ], + "type": "object" + } + ] + }, + "type": "array" + } + ] + }, + "dataconnect": { + "anyOf": [ + { + "$ref": "#/definitions/DataConnectSingle" + }, + { + "items": { + "$ref": "#/definitions/DataConnectSingle" + }, + "type": "array" + } + ] + }, + "emulators": { + "additionalProperties": false, + "properties": { + "apphosting": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + }, + "rootDirectory": { + "type": "string" + }, + "startCommand": { + "type": "string" + }, + "startCommandOverride": { + "type": "string" + } + }, + "type": "object" + }, + "auth": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "database": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "dataconnect": { + "additionalProperties": false, + "properties": { + "dataDir": { + "type": "string" + }, + "host": { + "type": "string" + }, + "port": { + "type": "number" + }, + "postgresHost": { + "type": "string" + }, + "postgresPort": { + "type": "number" + } + }, + "type": "object" + }, + "eventarc": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "extensions": { + "properties": {}, + "type": "object" + }, + "firestore": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + }, + "websocketPort": { + "type": "number" + } + }, + "type": "object" + }, + "functions": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "hosting": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "hub": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "logging": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "pubsub": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "singleProjectMode": { + "type": "boolean" + }, + "storage": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "tasks": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + }, + "ui": { + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean" + }, + "host": { + "type": "string" + }, + "port": { + "type": "number" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "extensions": { + "$ref": "#/definitions/ExtensionsConfig" + }, + "firestore": { + "anyOf": [ + { + "$ref": "#/definitions/FirestoreSingle" + }, + { + "items": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "database": { + "type": "string" + }, + "indexes": { + "type": "string" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + }, + "target": { + "type": "string" + } + }, + "required": [ + "target" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "database": { + "type": "string" + }, + "indexes": { + "type": "string" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + }, + "target": { + "type": "string" + } + }, + "required": [ + "database" + ], + "type": "object" + } + ] + }, + "type": "array" + } + ] + }, + "functions": { + "anyOf": [ + { + "$ref": "#/definitions/FunctionConfig" + }, + { + "items": { + "$ref": "#/definitions/FunctionConfig" + }, + "type": "array" + } + ] + }, + "hosting": { + "anyOf": [ + { + "$ref": "#/definitions/HostingSingle" + }, + { + "items": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "appAssociation": { + "enum": [ + "AUTO", + "NONE" + ], + "type": "string" + }, + "cleanUrls": { + "type": "boolean" + }, + "frameworksBackend": { + "$ref": "#/definitions/FrameworksBackendOptions" + }, + "headers": { + "items": { + "$ref": "#/definitions/HostingHeaders" + }, + "type": "array" + }, + "i18n": { + "additionalProperties": false, + "properties": { + "root": { + "type": "string" + } + }, + "required": [ + "root" + ], + "type": "object" + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "public": { + "type": "string" + }, + "redirects": { + "items": { + "$ref": "#/definitions/HostingRedirects" + }, + "type": "array" + }, + "rewrites": { + "items": { + "$ref": "#/definitions/HostingRewrites" + }, + "type": "array" + }, + "site": { + "type": "string" + }, + "source": { + "type": "string" + }, + "target": { + "type": "string" + }, + "trailingSlash": { + "type": "boolean" + } + }, + "required": [ + "target" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "appAssociation": { + "enum": [ + "AUTO", + "NONE" + ], + "type": "string" + }, + "cleanUrls": { + "type": "boolean" + }, + "frameworksBackend": { + "$ref": "#/definitions/FrameworksBackendOptions" + }, + "headers": { + "items": { + "$ref": "#/definitions/HostingHeaders" + }, + "type": "array" + }, + "i18n": { + "additionalProperties": false, + "properties": { + "root": { + "type": "string" + } + }, + "required": [ + "root" + ], + "type": "object" + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "public": { + "type": "string" + }, + "redirects": { + "items": { + "$ref": "#/definitions/HostingRedirects" + }, + "type": "array" + }, + "rewrites": { + "items": { + "$ref": "#/definitions/HostingRewrites" + }, + "type": "array" + }, + "site": { + "type": "string" + }, + "source": { + "type": "string" + }, + "target": { + "type": "string" + }, + "trailingSlash": { + "type": "boolean" + } + }, + "required": [ + "site" + ], + "type": "object" + } + ] + }, + "type": "array" + } + ] + }, + "remoteconfig": { + "$ref": "#/definitions/RemoteConfigConfig" + }, + "storage": { + "anyOf": [ + { + "$ref": "#/definitions/StorageSingle" + }, + { + "items": { + "additionalProperties": false, + "properties": { + "bucket": { + "type": "string" + }, + "postdeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "predeploy": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "string" + } + ] + }, + "rules": { + "type": "string" + }, + "target": { + "type": "string" + } + }, + "required": [ + "bucket", + "rules" + ], + "type": "object" + }, + "type": "array" + } + ] + } + }, + "type": "object" +} +``` + + diff --git a/schema/docs/index.md b/schema/docs/index.md new file mode 100644 index 00000000000..16187f0d832 --- /dev/null +++ b/schema/docs/index.md @@ -0,0 +1,5 @@ +# Index +- [connector-yaml](connector-yaml.md) +- [dataconnect-yaml](dataconnect-yaml.md) +- [extension-yaml](extension-yaml.md) +- [firebase-config](firebase-config.md) diff --git a/schema/extension-yaml.json b/schema/extension-yaml.json index 261da16c4a9..7ba7e2f99cc 100644 --- a/schema/extension-yaml.json +++ b/schema/extension-yaml.json @@ -1,5 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "extension.yaml", "additionalProperties": false, "definitions": { "author": { @@ -336,8 +337,11 @@ "properties": { "attribute": { "type": "string", - "description": "The event attribute to filter on", - "value": "The value to filter for" + "description": "The event attribute to filter on" + }, + "value": { + "type": "string", + "description": "The value to filter for" } } } diff --git a/schema/firebase-config.json b/schema/firebase-config.json index 546d045af00..56efe8bed8a 100644 --- a/schema/firebase-config.json +++ b/schema/firebase-config.json @@ -1,5 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "firebase.json", "additionalProperties": false, "definitions": { "DataConnectSingle": { diff --git a/scripts/docs-gen/index.js b/scripts/docs-gen/index.js new file mode 100644 index 00000000000..fe95b7436a6 --- /dev/null +++ b/scripts/docs-gen/index.js @@ -0,0 +1,13 @@ +const JsonSchemaStaticDocs = require("json-schema-static-docs"); + +(async () => { + let jsonSchemaStaticDocs = new JsonSchemaStaticDocs({ + inputPath: "../../schema", + outputPath: "../../schema/docs", + ajvOptions: { + allowUnionTypes: true, + }, + }); + await jsonSchemaStaticDocs.generate(); + console.log("Documents generated."); +})(); \ No newline at end of file diff --git a/scripts/docs-gen/package-lock.json b/scripts/docs-gen/package-lock.json new file mode 100644 index 00000000000..59744d197d3 --- /dev/null +++ b/scripts/docs-gen/package-lock.json @@ -0,0 +1,1049 @@ +{ + "name": "docs-gen", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "docs-gen", + "version": "1.0.0", + "license": "ISC", + "dependencies": { + "json-schema-static-docs": "^0.28.1" + } + }, + "node_modules/@apidevtools/json-schema-ref-parser": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-10.1.0.tgz", + "integrity": "sha512-3e+viyMuXdrcK8v5pvP+SDoAQ77FH6OyRmuK48SZKmdHJRFm87RsSs8qm6kP39a/pOPURByJw+OXzQIqcfmKtA==", + "license": "MIT", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.11", + "@types/lodash.clonedeep": "^4.5.7", + "js-yaml": "^4.1.0", + "lodash.clonedeep": "^4.5.0" + }, + "engines": { + "node": ">= 16" + }, + "funding": { + "url": "https://github.com/sponsors/philsturgeon" + } + }, + "node_modules/@isaacs/cliui": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", + "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", + "license": "ISC", + "dependencies": { + "string-width": "^5.1.2", + "string-width-cjs": "npm:string-width@^4.2.0", + "strip-ansi": "^7.0.1", + "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", + "wrap-ansi": "^8.1.0", + "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@jsdevtools/ono": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", + "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", + "license": "MIT" + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@pkgjs/parseargs": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", + "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", + "license": "MIT", + "optional": true, + "engines": { + "node": ">=14" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "license": "MIT" + }, + "node_modules/@types/lodash": { + "version": "4.17.17", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.17.tgz", + "integrity": "sha512-RRVJ+J3J+WmyOTqnz3PiBLA501eKwXl2noseKOrNo/6+XEHjTAxO4xHvxQB6QuNm+s4WRbn6rSiap8+EA+ykFQ==", + "license": "MIT" + }, + "node_modules/@types/lodash.clonedeep": { + "version": "4.5.9", + "resolved": "https://registry.npmjs.org/@types/lodash.clonedeep/-/lodash.clonedeep-4.5.9.tgz", + "integrity": "sha512-19429mWC+FyaAhOLzsS8kZUsI+/GmBAQ0HFiCPsKGU+7pBXOQWhyrY6xNNDwUSX8SMZMJvuFVMF9O5dQOlQK9Q==", + "license": "MIT", + "dependencies": { + "@types/lodash": "*" + } + }, + "node_modules/ajv": { + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", + "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-3.0.1.tgz", + "integrity": "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ==", + "license": "MIT", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ansi-regex": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", + "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/ansi-styles": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" + }, + "node_modules/cross-spawn": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "license": "MIT" + }, + "node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "license": "MIT" + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "license": "MIT" + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" + }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-uri": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.6.tgz", + "integrity": "sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/fastq": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", + "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/foreground-child": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.1.tgz", + "integrity": "sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw==", + "license": "ISC", + "dependencies": { + "cross-spawn": "^7.0.6", + "signal-exit": "^4.0.1" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob": { + "version": "10.4.5", + "resolved": "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz", + "integrity": "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==", + "license": "ISC", + "dependencies": { + "foreground-child": "^3.1.0", + "jackspeak": "^3.1.2", + "minimatch": "^9.0.4", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^1.11.1" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/handlebars": { + "version": "4.7.8", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", + "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", + "license": "MIT", + "dependencies": { + "minimist": "^1.2.5", + "neo-async": "^2.6.2", + "source-map": "^0.6.1", + "wordwrap": "^1.0.0" + }, + "bin": { + "handlebars": "bin/handlebars" + }, + "engines": { + "node": ">=0.4.7" + }, + "optionalDependencies": { + "uglify-js": "^3.1.4" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "license": "ISC" + }, + "node_modules/jackspeak": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", + "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/cliui": "^8.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + }, + "optionalDependencies": { + "@pkgjs/parseargs": "^0.11.0" + } + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/json-schema-static-docs": { + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/json-schema-static-docs/-/json-schema-static-docs-0.28.1.tgz", + "integrity": "sha512-Ti4UO5wK1GqWzCuij57twgfT04NSoluPgLlnf8Sz9ex6tVEgCM2Z1niRSDkZgw7C4MNJM9MCwGdjtUGSbjO/eA==", + "license": "GPL-3.0-only", + "dependencies": { + "@apidevtools/json-schema-ref-parser": "^10.1.0", + "ajv": "^8.17.1", + "ajv-formats": "^3.0.1", + "extend": "^3.0.2", + "fast-glob": "^3.3.1", + "handlebars": "^4.7.7", + "jsonpointer": "^5.0.1", + "lodash": ">=4.17.21", + "make-dir": "^3.1.0", + "mkdirp": "^2.1.6", + "optimist": "^0.5.2", + "rimraf": "^5.0.10", + "yaml": "^2.2.2" + }, + "bin": { + "json-schema-static-docs": "cli.js" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, + "node_modules/jsonpointer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-5.0.1.tgz", + "integrity": "sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "license": "MIT" + }, + "node_modules/lodash.clonedeep": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", + "integrity": "sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ==", + "license": "MIT" + }, + "node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "license": "ISC" + }, + "node_modules/make-dir": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", + "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", + "license": "MIT", + "dependencies": { + "semver": "^6.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, + "node_modules/mkdirp": { + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-2.1.6.tgz", + "integrity": "sha512-+hEnITedc8LAtIP9u3HJDFIdcLV2vXP33sqLLIzkv1Db1zO/1OxbvYf0Y1OC/S/Qo5dxHXepofhmxL02PsKe+A==", + "license": "MIT", + "bin": { + "mkdirp": "dist/cjs/src/bin.js" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "license": "MIT" + }, + "node_modules/optimist": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/optimist/-/optimist-0.5.2.tgz", + "integrity": "sha512-r9M8ZpnM9SXV5Wii7TCqienfcaY3tAiJe9Jchof87icbmbruKgK0xKXngmrnowTDnEawmmI1Qbha59JEoBkBGA==", + "license": "MIT/X11", + "dependencies": { + "wordwrap": "~0.0.2" + } + }, + "node_modules/optimist/node_modules/wordwrap": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz", + "integrity": "sha512-1tMA907+V4QmxV7dbRvb4/8MaRALK6q9Abid3ndMYnbyo8piisCmeONVqVSXqQA3KaP4SLt5b7ud6E2sqP8TFw==", + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/package-json-from-dist": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", + "license": "BlueOak-1.0.0" + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-scurry": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", + "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", + "license": "BlueOak-1.0.0", + "dependencies": { + "lru-cache": "^10.2.0", + "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" + }, + "engines": { + "node": ">=16 || 14 >=14.18" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "5.0.10", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-5.0.10.tgz", + "integrity": "sha512-l0OE8wL34P4nJH/H2ffoaniAokM2qSmrtXHmlpvYr5AVVX8msAyW0l8NVJFDxlSK4u3Uh/f41cQheDVdnYijwQ==", + "license": "ISC", + "dependencies": { + "glob": "^10.3.7" + }, + "bin": { + "rimraf": "dist/esm/bin.mjs" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", + "license": "ISC", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "license": "MIT", + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/string-width-cjs": { + "name": "string-width", + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width-cjs/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/string-width-cjs/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/strip-ansi-cjs": { + "name": "strip-ansi", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/uglify-js": { + "version": "3.19.3", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz", + "integrity": "sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==", + "license": "BSD-2-Clause", + "optional": true, + "bin": { + "uglifyjs": "bin/uglifyjs" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", + "license": "MIT" + }, + "node_modules/wrap-ansi": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", + "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs": { + "name": "wrap-ansi", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/wrap-ansi-cjs/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yaml": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.0.tgz", + "integrity": "sha512-4lLa/EcQCB0cJkyts+FpIRx5G/llPxfP6VQU5KByHEhLxY3IJCH0f0Hy1MHI8sClTvsIb8qwRJ6R/ZdlDJ/leQ==", + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + } + } + } +} diff --git a/scripts/docs-gen/package.json b/scripts/docs-gen/package.json new file mode 100644 index 00000000000..9bf5b26f0b1 --- /dev/null +++ b/scripts/docs-gen/package.json @@ -0,0 +1,15 @@ +{ + "name": "docs-gen", + "version": "1.0.0", + "description": "Generate markdown docs for firebase.json and other schemas", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "generate-docs": "node index.js" + }, + "author": "", + "license": "ISC", + "dependencies": { + "json-schema-static-docs": "^0.28.1" + } +} From 1997dbedea73e0e5db5e6b1dd6639c018a7b8037 Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Mon, 16 Jun 2025 17:23:40 -0700 Subject: [PATCH 02/10] A bunch more comments and descriptions --- .../functions/runtimes/supported/types.ts | 3 + src/firebaseConfig.ts | 322 +++++++++++++++--- 2 files changed, 269 insertions(+), 56 deletions(-) diff --git a/src/deploy/functions/runtimes/supported/types.ts b/src/deploy/functions/runtimes/supported/types.ts index 7c127e4569a..cb3c8a3bace 100644 --- a/src/deploy/functions/runtimes/supported/types.ts +++ b/src/deploy/functions/runtimes/supported/types.ts @@ -123,4 +123,7 @@ export type DecommissionedRuntime = { : never; }[keyof typeof RUNTIMES]; +/** + * The Cloud Functions runtimes that currently can be deployed by `firebase deploy`. + */ export type ActiveRuntime = Exclude; diff --git a/src/firebaseConfig.ts b/src/firebaseConfig.ts index b0c46bee651..50614deec2a 100644 --- a/src/firebaseConfig.ts +++ b/src/firebaseConfig.ts @@ -19,34 +19,86 @@ export type RequireAtLeastOne = { [K in keyof T]-?: Required> & Partial>>; }[keyof T]; +/** + * Common configuration options for all Firebase products that can be deployed by the Firebase CLI. + */ export type Deployable = { + /** + * A script or list of scripts that will be ran before this product is deployed. + */ predeploy?: string | string[]; + /** + * A script or list of scripts that will be ran after this product is deployed. + */ postdeploy?: string | string[]; }; +/** + * Deployment options for a single Realtime Database instance. + */ type DatabaseSingle = { + /** + * The rules files for this Realtime Database instance. + */ rules: string; } & Deployable; +/** + * Deployment options for a list of Realtime Database instancs. + */ type DatabaseMultiple = ({ + /** + * The rules files for this Realtime Database instance. + */ rules: string; } & RequireAtLeastOne<{ + + /** + * The instance that this rules files is for. + */ instance: string; target: string; }> & Deployable)[]; +/** + * Deployment options for a single Firestore database. + */ type FirestoreSingle = { + /** + * The id of the Firestore database to deploy. If omitted, defaults to '(default)' + */ database?: string; + /** + * The region of the Firestore database to deploy. Required when 'database' is set. + */ location?: string; + /** + * Path to the firestore rules file + */ rules?: string; + /** + * Path to the firestore indexes file + */ indexes?: string; } & Deployable; +/** + * Deployment options for a list of Firestore databases. + */ type FirestoreMultiple = ({ + /** + * Path to the firestore rules file for this database + */ rules?: string; + /** + * Path to the firestore indexes file for this database + */ indexes?: string; } & RequireAtLeastOne<{ + /** + * The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. + */ database: string; target: string; }> & @@ -68,10 +120,16 @@ export type FunctionsRewrite = { pinTag?: boolean; }; }; +/** + * A Hosting rewrite to a Cloud Run service. + */ export type RunRewrite = { run: { + /** The ID of the Cloud Run service to rewrite to. */ serviceId: string; + //** The region of the Cloud Run service to rewrite to. */ region?: string; + /** If true, traffic will be pinned to the currently running version of the Cloud Run service. */ pinTag?: boolean; }; }; @@ -149,146 +207,298 @@ export type HostingMultiple = (HostingBase & }> & Deployable)[]; +/** + * Deployment options for a single Firebase storage bucket. + */ type StorageSingle = { + /** + * Path to the rules files for this Firebase Storage bucket. + */ rules: string; target?: string; } & Deployable; +/** + * Deployment options for multiple Firebase storage buckets. + */ type StorageMultiple = ({ + /** + * Path to the rules files for this Firebase Storage bucket. + */ rules: string; + /** + * The Firebase Storage bucket that this config is for. + */ bucket: string; target?: string; } & Deployable)[]; -// Full Configs +/** + * A single or list of Realtime Database deployment configs + */ export type DatabaseConfig = DatabaseSingle | DatabaseMultiple; +/** + * A single or list of Firestore deployment configs + */ export type FirestoreConfig = FirestoreSingle | FirestoreMultiple; export type FunctionConfig = { + /** + * The directory containing your functions source code. + * This directory will be archived and uploaded during deployment. + * Files outside of this directory will not be included and should not be referenced from your functions code. + */ source?: string; + /** + * Files in the source directory that should not be uploaed during dpeloyment. + */ ignore?: string[]; + /** + * The runtime these functions should use. + */ runtime?: ActiveRuntime; + /** + * The codebase that these functions are part of. You can use codebases to control which functions are deployed + * ie: `firebase deploy --only functions:my-codebase` + */ codebase?: string; } & Deployable; +/** + * A single or list of Cloud Functions for Firebase deployment configs + */ export type FunctionsConfig = FunctionConfig | FunctionConfig[]; +/** + * A single or list of Firebase Hosting deployment configs + */ export type HostingConfig = HostingSingle | HostingMultiple; +/** + * A single or list of Firebase Storage deployment configs + */ export type StorageConfig = StorageSingle | StorageMultiple; export type RemoteConfigConfig = { template: string; } & Deployable; +/** + * Configures the host and port an emulator will be served. If omitted, the emulator suite will + * automatically discover available ports. + */ +type EmulatorServingConfig = { + /** + * The host that this emulator will serve on. + */ + host?: string; + /** + * The port that this emulator will serve on. + */ + port?: number; +} + +/** + * Hosts, ports, and configuration options for the Firebase Emulator suite. + */ export type EmulatorsConfig = { - auth?: { - host?: string; - port?: number; - }; - database?: { - host?: string; - port?: number; - }; - firestore?: { - host?: string; - port?: number; + /** + * Config for the Auth emulator + */ + auth?: EmulatorServingConfig; + /** + * Config for the Realtime Database emulator + */ + database?: EmulatorServingConfig; + /** + * Config for the Firestore emulator + */ + firestore?: EmulatorServingConfig & { websocketPort?: number; }; - functions?: { - host?: string; - port?: number; - }; - hosting?: { - host?: string; - port?: number; - }; - apphosting?: { - host?: string; - port?: number; + /** + * Config for the Firebase Hosting emulator + */ + hosting?: EmulatorServingConfig; + /** + * Config for the App Hosting emulator + */ + apphosting?: EmulatorServingConfig & { + + /** The command that will be run to start your app when emulating your App Hosting backend */ startCommand?: string; /** * @deprecated */ startCommandOverride?: string; + /** The root directory of your app. The start command will ran from this directory. */ rootDirectory?: string; }; - pubsub?: { - host?: string; - port?: number; - }; - storage?: { - host?: string; - port?: number; - }; - logging?: { - host?: string; - port?: number; - }; - hub?: { - host?: string; - port?: number; - }; - ui?: { + /** + * Config for the Pub/Sub emulator + */ + pubsub?: EmulatorServingConfig; + /** + * Config for the Firebase Storage emulator + */ + storage?: EmulatorServingConfig; + /** + * Config for the logging emulator. + */ + logging?: EmulatorServingConfig; + /** + * Config for the emulator suite hub. + */ + hub?: EmulatorServingConfig; + /** + * Config for the Emulator UI. + */ + ui?: EmulatorServingConfig & { + /** + * If false, the Emulator UI will not be served. + */ enabled?: boolean; - host?: string; - port?: number; }; + /** + * Placeholder - the Extensions emulator has no configuration options. + */ extensions?: {}; - eventarc?: { - host?: string; - port?: number; - }; + /** + * Config for the EventArc emulator. + */ + eventarc?: EmulatorServingConfig; + /** + * If true, the Emulator Suite will only allow a single project to be used at a time. + */ singleProjectMode?: boolean; - dataconnect?: { - host?: string; - port?: number; + /** + * Config for the Data Connect emulator. + */ + dataconnect?: EmulatorServingConfig & { + /** + * Host for the Postgres database that backs the Data Connect emulator. + */ postgresHost?: string; + /** + * Port for the Postgres database that backs the Data Connect emulator. + */ postgresPort?: number; + /** + * The directory to persist emulator data to. If set, data will be saved between runs automatically. + * If the --import flag is used, the current data will be overwritten by the imported data. + */ dataDir?: string; }; - tasks?: { - host?: string; - port?: number; - }; + /** + * Config for the Cloud Tasks emulator. + */ + tasks?: EmulatorServingConfig; }; +/** + * The Firebase Extensions that should be deployed to this project. + * This is a map of instance ID to extension reference (/@)- ie: + * "my-firestore-export": "firebase/firestore-bigquery-export@1.2.3" + * + * Version can also be a semver range. + */ export type ExtensionsConfig = Record; +/** + * A single Data Connect deployment configs + */ export type DataConnectSingle = { // The directory containing dataconnect.yaml for this service source: string; } & Deployable; +/** + * A list of Data Connect deployment configs + */ export type DataConnectMultiple = DataConnectSingle[]; +/** + * A single or list of Data Connect deployment configs + */ export type DataConnectConfig = DataConnectSingle | DataConnectMultiple; +/** + * A single App Hosting deployment configs + */ export type AppHostingSingle = { + // The ID of the backend that should be deployed. backendId: string; + // The root directory of your app. This directory will be archived and uploaded during dpeloyment. rootDir: string; + /** + * A list of file paths to exclude from the archive that is uploaded for this backend. + */ ignore: string[]; + /** + * If true, this backend will only be deployed from local source, not from source control. + */ alwaysDeployFromSource?: boolean; }; +/** + * A list of App Hosting deployment configs + */ export type AppHostingMultiple = AppHostingSingle[]; +/** + * A single or list of App Hosting deployment configs + */ export type AppHostingConfig = AppHostingSingle | AppHostingMultiple; +/** + * Information about the resources in your Firebase project. + * This used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start` + */ export type FirebaseConfig = { /** - * @TJS-format uri + * The Realtime Database rules that should be deployed or emulated. */ - $schema?: string; database?: DatabaseConfig; + /** + * The Firestore rules and indexes that should be deployed or emulated. + */ firestore?: FirestoreConfig; + /** + * The Cloud Functions for Firebase that should be deployed or emulated. + */ functions?: FunctionsConfig; + /** + * The Firebase Hosting site(s) that should be deployed or emulated. + */ hosting?: HostingConfig; + /** + * The Firebase Storage rules that should be deployed or emulated. + */ storage?: StorageConfig; + /** + * The Remote Config template(s) used by this project. + */ remoteconfig?: RemoteConfigConfig; - emulators?: EmulatorsConfig; + /** + * The Firebase Extension(s) that should be deployed or emulated. + */ extensions?: ExtensionsConfig; + /** + * The Data Connect service(s) that should be deployed or emulated. + */ dataconnect?: DataConnectConfig; + /** + * The App Hosting backend(s) that should be deployed or emulated. + */ apphosting?: AppHostingConfig; + /** + * Hosts, ports, and configuration options for the Firebase Emulator suite. + */ + emulators?: EmulatorsConfig; + /** + * Unused. Included in schema so that the schema can be applied to single files. + * @TJS-format uri + */ + $schema?: string; }; From 88697ef69c564ca0a310977675bc07b7693d75b0 Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Mon, 16 Jun 2025 17:28:40 -0700 Subject: [PATCH 03/10] Include changes in docs --- schema/docs/firebase-config.md | 725 ++++++++++++++++++++++++++++----- schema/firebase-config.json | 230 ++++++++--- 2 files changed, 794 insertions(+), 161 deletions(-) diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md index 2979cb07fd8..0e78eb2a2bb 100644 --- a/schema/docs/firebase-config.md +++ b/schema/docs/firebase-config.md @@ -1,12 +1,13 @@ -# +# Information about the resources in your Firebase project. +This used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start` - +
$idfirebase.json
$schemahttp://json-schema.org/draft-07/schema#
@@ -25,6 +26,10 @@ + + + + @@ -45,6 +50,10 @@
DescriptionUnused. Included in schema so that the schema can be applied to single files.
TypeString
Required
+ + + + @@ -61,6 +70,10 @@
DescriptionThe App Hosting backend(s) that should be deployed or emulated.
TypeAny of:Object
Array
Required
+ + + + @@ -73,6 +86,10 @@
DescriptionA single App Hosting deployment configs
TypeObject
+ + + + @@ -99,6 +116,10 @@
DescriptionIf true, this backend will only be deployed from local source, not from source control.
TypeBoolean
+ + + + @@ -126,6 +147,10 @@
DescriptionA list of file paths to exclude from the archive that is uploaded for this backend.
TypeArray
+ + + + @@ -138,6 +163,10 @@
DescriptionA list of App Hosting deployment configs
TypeArray
+ + + + @@ -164,6 +193,10 @@
DescriptionIf true, this backend will only be deployed from local source, not from source control.
TypeBoolean
+ + + + @@ -192,6 +225,10 @@
DescriptionA list of file paths to exclude from the archive that is uploaded for this backend.
TypeArray
+ + + + @@ -208,6 +245,10 @@
DescriptionThe Realtime Database rules that should be deployed or emulated.
TypeAny of:Object
Array
Required
+ + + + @@ -220,6 +261,10 @@
DescriptionDeployment options for a single Realtime Database instance.
TypeObject
+ + + + @@ -259,6 +304,10 @@
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -298,6 +347,10 @@
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -312,6 +365,10 @@
DescriptionThe rules files for this Realtime Database instance.
TypeString
+ + + + @@ -326,6 +383,10 @@
DescriptionDeployment options for a list of Realtime Database instancs.
TypeArray
+ + + + @@ -342,6 +403,10 @@
DescriptionThe Data Connect service(s) that should be deployed or emulated.
TypeAny of:Object
Array
Required
+ + + + @@ -354,6 +419,10 @@
DescriptionA single Data Connect deployment configs
TypeObject
+ + + + @@ -393,6 +462,10 @@
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -446,6 +519,10 @@
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -458,6 +535,10 @@
DescriptionA list of Data Connect deployment configs
TypeArray
+ + + + @@ -497,6 +578,10 @@
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -551,6 +636,10 @@
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -561,7 +650,7 @@
DescriptionHosts, ports, and configuration options for the Firebase Emulator suite.
TypeObject
Required
### Properties -
NameType
apphostingObject
authObject
databaseObject
dataconnectObject
eventarcObject
extensionsObject
firestoreObject
functionsObject
hostingObject
hubObject
loggingObject
pubsubObject
singleProjectModeBoolean
storageObject
tasksObject
uiObject
+
NameType
apphostingObject
authObject
databaseObject
dataconnectObject
eventarcObject
extensionsObject
firestoreObject
hostingObject
hubObject
loggingObject
pubsubObject
singleProjectModeBoolean
storageObject
tasksObject
uiObject
### emulators.apphosting @@ -569,6 +658,10 @@ + + + + @@ -585,6 +678,10 @@
DescriptionConfig for the App Hosting emulator
TypeObject
Required
+ + + + @@ -602,6 +699,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -619,6 +720,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -636,6 +741,10 @@
DescriptionThe root directory of your app. The start command will ran from this directory.
TypeString
Required
+ + + + @@ -671,6 +780,10 @@
DescriptionThe command that will be run to start your app when emulating your App Hosting backend
TypeString
Required
+ + + + @@ -687,6 +800,10 @@
DescriptionConfig for the Auth emulator
TypeObject
Required
+ + + + @@ -704,6 +821,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -722,6 +843,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -738,6 +863,10 @@
DescriptionConfig for the Realtime Database emulator
TypeObject
Required
+ + + + @@ -755,6 +884,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -773,6 +906,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -789,6 +926,11 @@
DescriptionConfig for the Data Connect emulator.
TypeObject
Required
+ + + + @@ -806,6 +948,10 @@
DescriptionThe directory to persist emulator data to. If set, data will be saved between runs automatically. +If the --import flag is used, the current data will be overwritten by the imported data.
TypeString
Required
+ + + + @@ -823,6 +969,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -840,6 +990,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -857,6 +1011,10 @@
DescriptionHost for the Postgres database that backs the Data Connect emulator.
TypeString
Required
+ + + + @@ -875,6 +1033,10 @@
DescriptionPort for the Postgres database that backs the Data Connect emulator.
TypeNumber
Required
+ + + + @@ -891,6 +1053,10 @@
DescriptionConfig for the EventArc emulator.
TypeObject
Required
+ + + + @@ -908,6 +1074,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -926,6 +1096,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -943,6 +1117,10 @@
DescriptionPlaceholder - the Extensions emulator has no configuration options.
TypeObject
Required
+ + + + @@ -959,6 +1137,10 @@
DescriptionConfig for the Firestore emulator
TypeObject
Required
+ + + + @@ -976,23 +1158,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
- - - + + - - -
TypeNumber
RequiredNoDescriptionThe port that this emulator will serve on.
- - - - -### emulators.firestore.websocketPort - - - - @@ -1005,41 +1174,7 @@ - -### emulators.functions - - -
TypeNumber
Required
- - - - - - - - -
TypeObject
RequiredNo
- - - -### emulators.functions.host - - - - - - - - - - - -
TypeString
RequiredNo
- - - - -### emulators.functions.port +### emulators.firestore.websocketPort @@ -1062,6 +1197,10 @@
+ + + + @@ -1078,6 +1217,10 @@
DescriptionConfig for the Firebase Hosting emulator
TypeObject
Required
+ + + + @@ -1095,6 +1238,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -1113,6 +1260,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -1129,6 +1280,10 @@
DescriptionConfig for the emulator suite hub.
TypeObject
Required
+ + + + @@ -1146,6 +1301,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -1164,6 +1323,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -1180,6 +1343,10 @@
DescriptionConfig for the logging emulator.
TypeObject
Required
+ + + + @@ -1197,6 +1364,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -1215,6 +1386,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -1231,6 +1406,10 @@
DescriptionConfig for the Pub/Sub emulator
TypeObject
Required
+ + + + @@ -1248,6 +1427,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -1266,6 +1449,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -1283,6 +1470,10 @@
DescriptionIf true, the Emulator Suite will only allow a single project to be used at a time.
TypeBoolean
Required
+ + + + @@ -1299,6 +1490,10 @@
DescriptionConfig for the Firebase Storage emulator
TypeObject
Required
+ + + + @@ -1316,6 +1511,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -1334,6 +1533,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -1350,6 +1553,10 @@
DescriptionConfig for the Cloud Tasks emulator.
TypeObject
Required
+ + + + @@ -1367,6 +1574,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -1385,6 +1596,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -1401,6 +1616,10 @@
DescriptionConfig for the Emulator UI.
TypeObject
Required
+ + + + @@ -1418,6 +1637,10 @@
DescriptionIf false, the Emulator UI will not be served.
TypeBoolean
Required
+ + + + @@ -1435,6 +1658,10 @@
DescriptionThe host that this emulator will serve on.
TypeString
Required
+ + + + @@ -1454,6 +1681,10 @@
DescriptionThe port that this emulator will serve on.
TypeNumber
Required
+ + + + @@ -1471,6 +1702,10 @@
DescriptionThe Firebase Extension(s) that should be deployed or emulated.
TypeObject
Required
+ + + + @@ -1487,6 +1722,10 @@
DescriptionThe Firestore rules and indexes that should be deployed or emulated.
TypeAny of:Object
Array
Required
+ + + + @@ -1499,6 +1738,10 @@
DescriptionDeployment options for a single Firestore database.
TypeObject
+ + + + @@ -1512,6 +1755,10 @@
DescriptionThe id of the Firestore database to deploy. If omitted, defaults to '(default)'
TypeString
+ + + + @@ -1525,6 +1772,10 @@
DescriptionPath to the firestore indexes file
TypeString
+ + + + @@ -1538,6 +1789,10 @@
DescriptionThe region of the Firestore database to deploy. Required when 'database' is set.
TypeString
+ + + + @@ -1577,6 +1832,10 @@
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -1616,6 +1875,10 @@
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -1630,6 +1893,10 @@
DescriptionPath to the firestore rules file
TypeString
+ + + + @@ -1644,6 +1911,10 @@
DescriptionDeployment options for a list of Firestore databases.
TypeArray
+ + + + @@ -1672,6 +1943,11 @@
DescriptionThe Cloud Functions for Firebase that should be deployed or emulated.
TypeAny of:Object
Array
Required
+ + + + @@ -1685,6 +1961,10 @@
DescriptionThe codebase that these functions are part of. You can use codebases to control which functions are deployed + ie: `firebase deploy --only functions:my-codebase`
TypeString
+ + + + @@ -1698,6 +1978,10 @@
DescriptionFiles in the source directory that should not be uploaed during dpeloyment.
TypeArray
+ + + + @@ -1737,6 +2021,10 @@
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -1776,6 +2064,10 @@
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -1792,6 +2084,12 @@
DescriptionThe runtime these functions should use.
TypeString
Enum
+ + + + @@ -1818,6 +2116,11 @@
DescriptionThe directory containing your functions source code. +This directory will be archived and uploaded during deployment. +Files outside of this directory will not be included and should not be referenced from your functions code.
TypeString
+ + + + @@ -1831,6 +2134,10 @@
DescriptionThe codebase that these functions are part of. You can use codebases to control which functions are deployed + ie: `firebase deploy --only functions:my-codebase`
TypeString
+ + + + @@ -1844,6 +2151,10 @@
DescriptionFiles in the source directory that should not be uploaed during dpeloyment.
TypeArray
+ + + + @@ -1883,6 +2194,10 @@
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -1922,6 +2237,10 @@
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -1938,6 +2257,12 @@
DescriptionThe runtime these functions should use.
TypeString
Enum
+ + + + @@ -1953,6 +2278,10 @@
DescriptionThe directory containing your functions source code. +This directory will be archived and uploaded during deployment. +Files outside of this directory will not be included and should not be referenced from your functions code.
TypeString
+ + + + @@ -2422,6 +2751,10 @@ HTTPS functions can specify a higher timeout.
DescriptionThe Firebase Hosting site(s) that should be deployed or emulated.
TypeAny of:Object
Array
Required
+ + + + @@ -2461,6 +2794,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -2606,6 +2943,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -2624,6 +2965,10 @@ HTTPS functions can specify a higher timeout.
DescriptionThe Remote Config template(s) used by this project.
TypeObject
Required
+ + + + @@ -2667,6 +3012,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
Required
+ + + + @@ -2728,6 +3077,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
Required
+ + + + @@ -2744,6 +3097,10 @@ HTTPS functions can specify a higher timeout.
DescriptionThe Firebase Storage rules that should be deployed or emulated.
TypeAny of:Object
Array
Required
+ + + + @@ -2756,6 +3113,10 @@ HTTPS functions can specify a higher timeout.
DescriptionDeployment options for a single Firebase storage bucket.
TypeObject
+ + + + @@ -2795,6 +3156,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -2834,6 +3199,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -2861,6 +3230,10 @@ HTTPS functions can specify a higher timeout.
DescriptionPath to the rules files for this Firebase Storage bucket.
TypeString
+ + + + @@ -2873,6 +3246,10 @@ HTTPS functions can specify a higher timeout.
DescriptionDeployment options for multiple Firebase storage buckets.
TypeArray
+ + + + @@ -2886,6 +3263,10 @@ HTTPS functions can specify a higher timeout.
DescriptionThe Firebase Storage bucket that this config is for.
TypeString
+ + + + @@ -2925,6 +3306,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ + + + @@ -2964,6 +3349,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+ + + + @@ -2998,11 +3387,11 @@ HTTPS functions can specify a higher timeout. ``` { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "firebase.json", "additionalProperties": false, "definitions": { "DataConnectSingle": { "additionalProperties": false, + "description": "A single Data Connect deployment configs", "properties": { "postdeploy": { "anyOf": [ @@ -3015,7 +3404,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -3028,7 +3418,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "source": { "type": "string" @@ -3041,6 +3432,7 @@ HTTPS functions can specify a higher timeout. }, "DatabaseSingle": { "additionalProperties": false, + "description": "Deployment options for a single Realtime Database instance.", "properties": { "postdeploy": { "anyOf": [ @@ -3053,7 +3445,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -3066,9 +3459,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "The rules files for this Realtime Database instance.", "type": "string" } }, @@ -3079,18 +3474,23 @@ HTTPS functions can specify a higher timeout. }, "ExtensionsConfig": { "additionalProperties": false, + "description": "The Firebase Extensions that should be deployed to this project.\nThis is a map of instance ID to extension reference (/@)- ie:\n\"my-firestore-export\": \"firebase/firestore-bigquery-export@1.2.3\"\n\nVersion can also be a semver range.", "type": "object" }, "FirestoreSingle": { "additionalProperties": false, + "description": "Deployment options for a single Firestore database.", "properties": { "database": { + "description": "The id of the Firestore database to deploy. If omitted, defaults to '(default)'", "type": "string" }, "indexes": { + "description": "Path to the firestore indexes file", "type": "string" }, "location": { + "description": "The region of the Firestore database to deploy. Required when 'database' is set.", "type": "string" }, "postdeploy": { @@ -3104,7 +3504,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -3117,9 +3518,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the firestore rules file", "type": "string" } }, @@ -3241,9 +3644,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "codebase": { + "description": "The codebase that these functions are part of. You can use codebases to control which functions are deployed\n ie: `firebase deploy --only functions:my-codebase`", "type": "string" }, "ignore": { + "description": "Files in the source directory that should not be uploaed during dpeloyment.", "items": { "type": "string" }, @@ -3260,7 +3665,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -3273,9 +3679,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "runtime": { + "description": "The runtime these functions should use.", "enum": [ "nodejs20", "nodejs22", @@ -3287,6 +3695,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "source": { + "description": "The directory containing your functions source code.\nThis directory will be archived and uploaded during deployment.\nFiles outside of this directory will not be included and should not be referenced from your functions code.", "type": "string" } }, @@ -3531,12 +3940,14 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "pinTag": { + "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", "type": "boolean" }, "region": { "type": "string" }, "serviceId": { + "description": "The ID of the Cloud Run service to rewrite to.", "type": "string" } }, @@ -3641,12 +4052,14 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "pinTag": { + "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", "type": "boolean" }, "region": { "type": "string" }, "serviceId": { + "description": "The ID of the Cloud Run service to rewrite to.", "type": "string" } }, @@ -3757,12 +4170,14 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "pinTag": { + "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", "type": "boolean" }, "region": { "type": "string" }, "serviceId": { + "description": "The ID of the Cloud Run service to rewrite to.", "type": "string" } }, @@ -3847,7 +4262,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -3860,7 +4276,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { "type": "string" @@ -3910,7 +4327,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -3923,7 +4341,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "template": { "type": "string" @@ -3936,6 +4355,7 @@ HTTPS functions can specify a higher timeout. }, "StorageSingle": { "additionalProperties": false, + "description": "Deployment options for a single Firebase storage bucket.", "properties": { "postdeploy": { "anyOf": [ @@ -3948,7 +4368,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -3961,9 +4382,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the rules files for this Firebase Storage bucket.", "type": "string" }, "target": { @@ -3976,8 +4399,10 @@ HTTPS functions can specify a higher timeout. "type": "object" } }, + "description": "Information about the resources in your Firebase project.\nThis used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start`", "properties": { "$schema": { + "description": "Unused. Included in schema so that the schema can be applied to single files.", "format": "uri", "type": "string" }, @@ -3985,14 +4410,17 @@ HTTPS functions can specify a higher timeout. "anyOf": [ { "additionalProperties": false, + "description": "A single App Hosting deployment configs", "properties": { "alwaysDeployFromSource": { + "description": "If true, this backend will only be deployed from local source, not from source control.", "type": "boolean" }, "backendId": { "type": "string" }, "ignore": { + "description": "A list of file paths to exclude from the archive that is uploaded for this backend.", "items": { "type": "string" }, @@ -4010,16 +4438,20 @@ HTTPS functions can specify a higher timeout. "type": "object" }, { + "description": "A list of App Hosting deployment configs", "items": { "additionalProperties": false, + "description": "A single App Hosting deployment configs", "properties": { "alwaysDeployFromSource": { + "description": "If true, this backend will only be deployed from local source, not from source control.", "type": "boolean" }, "backendId": { "type": "string" }, "ignore": { + "description": "A list of file paths to exclude from the archive that is uploaded for this backend.", "items": { "type": "string" }, @@ -4038,20 +4470,24 @@ HTTPS functions can specify a higher timeout. }, "type": "array" } - ] + ], + "description": "The App Hosting backend(s) that should be deployed or emulated." }, "database": { "anyOf": [ { - "$ref": "#/definitions/DatabaseSingle" + "$ref": "#/definitions/DatabaseSingle", + "description": "Deployment options for a single Realtime Database instance." }, { + "description": "Deployment options for a list of Realtime Database instancs.", "items": { "anyOf": [ { "additionalProperties": false, "properties": { "instance": { + "description": "The instance that this rules files is for.", "type": "string" }, "postdeploy": { @@ -4065,7 +4501,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -4078,9 +4515,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "The rules files for this Realtime Database instance.", "type": "string" }, "target": { @@ -4097,6 +4536,7 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "instance": { + "description": "The instance that this rules files is for.", "type": "string" }, "postdeploy": { @@ -4110,7 +4550,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -4123,9 +4564,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "The rules files for this Realtime Database instance.", "type": "string" }, "target": { @@ -4142,37 +4585,47 @@ HTTPS functions can specify a higher timeout. }, "type": "array" } - ] + ], + "description": "The Realtime Database rules that should be deployed or emulated." }, "dataconnect": { "anyOf": [ { - "$ref": "#/definitions/DataConnectSingle" + "$ref": "#/definitions/DataConnectSingle", + "description": "A single Data Connect deployment configs" }, { + "description": "A list of Data Connect deployment configs", "items": { "$ref": "#/definitions/DataConnectSingle" }, "type": "array" } - ] + ], + "description": "The Data Connect service(s) that should be deployed or emulated." }, "emulators": { "additionalProperties": false, + "description": "Hosts, ports, and configuration options for the Firebase Emulator suite.", "properties": { "apphosting": { "additionalProperties": false, + "description": "Config for the App Hosting emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" }, "rootDirectory": { + "description": "The root directory of your app. The start command will ran from this directory.", "type": "string" }, "startCommand": { + "description": "The command that will be run to start your app when emulating your App Hosting backend", "type": "string" }, "startCommandOverride": { @@ -4183,11 +4636,14 @@ HTTPS functions can specify a higher timeout. }, "auth": { "additionalProperties": false, + "description": "Config for the Auth emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4195,11 +4651,14 @@ HTTPS functions can specify a higher timeout. }, "database": { "additionalProperties": false, + "description": "Config for the Realtime Database emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4207,20 +4666,26 @@ HTTPS functions can specify a higher timeout. }, "dataconnect": { "additionalProperties": false, + "description": "Config for the Data Connect emulator.", "properties": { "dataDir": { + "description": "The directory to persist emulator data to. If set, data will be saved between runs automatically.\nIf the --import flag is used, the current data will be overwritten by the imported data.", "type": "string" }, "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" }, "postgresHost": { + "description": "Host for the Postgres database that backs the Data Connect emulator.", "type": "string" }, "postgresPort": { + "description": "Port for the Postgres database that backs the Data Connect emulator.", "type": "number" } }, @@ -4228,27 +4693,34 @@ HTTPS functions can specify a higher timeout. }, "eventarc": { "additionalProperties": false, + "description": "Config for the EventArc emulator.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, "type": "object" }, "extensions": { + "description": "Placeholder - the Extensions emulator has no configuration options.", "properties": {}, "type": "object" }, "firestore": { "additionalProperties": false, + "description": "Config for the Firestore emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" }, "websocketPort": { @@ -4257,25 +4729,16 @@ HTTPS functions can specify a higher timeout. }, "type": "object" }, - "functions": { - "additionalProperties": false, - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "number" - } - }, - "type": "object" - }, "hosting": { "additionalProperties": false, + "description": "Config for the Firebase Hosting emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4283,11 +4746,14 @@ HTTPS functions can specify a higher timeout. }, "hub": { "additionalProperties": false, + "description": "Config for the emulator suite hub.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4295,11 +4761,14 @@ HTTPS functions can specify a higher timeout. }, "logging": { "additionalProperties": false, + "description": "Config for the logging emulator.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4307,26 +4776,33 @@ HTTPS functions can specify a higher timeout. }, "pubsub": { "additionalProperties": false, + "description": "Config for the Pub/Sub emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, "type": "object" }, "singleProjectMode": { + "description": "If true, the Emulator Suite will only allow a single project to be used at a time.", "type": "boolean" }, "storage": { "additionalProperties": false, + "description": "Config for the Firebase Storage emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4334,11 +4810,14 @@ HTTPS functions can specify a higher timeout. }, "tasks": { "additionalProperties": false, + "description": "Config for the Cloud Tasks emulator.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4346,14 +4825,18 @@ HTTPS functions can specify a higher timeout. }, "ui": { "additionalProperties": false, + "description": "Config for the Emulator UI.", "properties": { "enabled": { + "description": "If false, the Emulator UI will not be served.", "type": "boolean" }, "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -4363,23 +4846,28 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "extensions": { - "$ref": "#/definitions/ExtensionsConfig" + "$ref": "#/definitions/ExtensionsConfig", + "description": "The Firebase Extension(s) that should be deployed or emulated." }, "firestore": { "anyOf": [ { - "$ref": "#/definitions/FirestoreSingle" + "$ref": "#/definitions/FirestoreSingle", + "description": "Deployment options for a single Firestore database." }, { + "description": "Deployment options for a list of Firestore databases.", "items": { "anyOf": [ { "additionalProperties": false, "properties": { "database": { + "description": "The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.", "type": "string" }, "indexes": { + "description": "Path to the firestore indexes file for this database", "type": "string" }, "postdeploy": { @@ -4393,7 +4881,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -4406,9 +4895,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the firestore rules file for this database", "type": "string" }, "target": { @@ -4424,9 +4915,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "database": { + "description": "The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.", "type": "string" }, "indexes": { + "description": "Path to the firestore indexes file for this database", "type": "string" }, "postdeploy": { @@ -4440,7 +4933,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -4453,9 +4947,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the firestore rules file for this database", "type": "string" }, "target": { @@ -4471,7 +4967,8 @@ HTTPS functions can specify a higher timeout. }, "type": "array" } - ] + ], + "description": "The Firestore rules and indexes that should be deployed or emulated." }, "functions": { "anyOf": [ @@ -4484,7 +4981,8 @@ HTTPS functions can specify a higher timeout. }, "type": "array" } - ] + ], + "description": "The Cloud Functions for Firebase that should be deployed or emulated." }, "hosting": { "anyOf": [ @@ -4545,7 +5043,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -4558,7 +5057,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { "type": "string" @@ -4644,7 +5144,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -4657,7 +5158,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { "type": "string" @@ -4696,21 +5198,26 @@ HTTPS functions can specify a higher timeout. }, "type": "array" } - ] + ], + "description": "The Firebase Hosting site(s) that should be deployed or emulated." }, "remoteconfig": { - "$ref": "#/definitions/RemoteConfigConfig" + "$ref": "#/definitions/RemoteConfigConfig", + "description": "The Remote Config template(s) used by this project." }, "storage": { "anyOf": [ { - "$ref": "#/definitions/StorageSingle" + "$ref": "#/definitions/StorageSingle", + "description": "Deployment options for a single Firebase storage bucket." }, { + "description": "Deployment options for multiple Firebase storage buckets.", "items": { "additionalProperties": false, "properties": { "bucket": { + "description": "The Firebase Storage bucket that this config is for.", "type": "string" }, "postdeploy": { @@ -4724,7 +5231,8 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -4737,9 +5245,11 @@ HTTPS functions can specify a higher timeout. { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the rules files for this Firebase Storage bucket.", "type": "string" }, "target": { @@ -4754,7 +5264,8 @@ HTTPS functions can specify a higher timeout. }, "type": "array" } - ] + ], + "description": "The Firebase Storage rules that should be deployed or emulated." } }, "type": "object" diff --git a/schema/firebase-config.json b/schema/firebase-config.json index 56efe8bed8a..2b2fe5f9c57 100644 --- a/schema/firebase-config.json +++ b/schema/firebase-config.json @@ -1,10 +1,10 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "firebase.json", "additionalProperties": false, "definitions": { "DataConnectSingle": { "additionalProperties": false, + "description": "A single Data Connect deployment configs", "properties": { "postdeploy": { "anyOf": [ @@ -17,7 +17,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -30,7 +31,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "source": { "type": "string" @@ -43,6 +45,7 @@ }, "DatabaseSingle": { "additionalProperties": false, + "description": "Deployment options for a single Realtime Database instance.", "properties": { "postdeploy": { "anyOf": [ @@ -55,7 +58,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -68,9 +72,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "The rules files for this Realtime Database instance.", "type": "string" } }, @@ -81,18 +87,23 @@ }, "ExtensionsConfig": { "additionalProperties": false, + "description": "The Firebase Extensions that should be deployed to this project.\nThis is a map of instance ID to extension reference (/@)- ie:\n\"my-firestore-export\": \"firebase/firestore-bigquery-export@1.2.3\"\n\nVersion can also be a semver range.", "type": "object" }, "FirestoreSingle": { "additionalProperties": false, + "description": "Deployment options for a single Firestore database.", "properties": { "database": { + "description": "The id of the Firestore database to deploy. If omitted, defaults to '(default)'", "type": "string" }, "indexes": { + "description": "Path to the firestore indexes file", "type": "string" }, "location": { + "description": "The region of the Firestore database to deploy. Required when 'database' is set.", "type": "string" }, "postdeploy": { @@ -106,7 +117,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -119,9 +131,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the firestore rules file", "type": "string" } }, @@ -243,9 +257,11 @@ "additionalProperties": false, "properties": { "codebase": { + "description": "The codebase that these functions are part of. You can use codebases to control which functions are deployed\n ie: `firebase deploy --only functions:my-codebase`", "type": "string" }, "ignore": { + "description": "Files in the source directory that should not be uploaed during dpeloyment.", "items": { "type": "string" }, @@ -262,7 +278,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -275,9 +292,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "runtime": { + "description": "The runtime these functions should use.", "enum": [ "nodejs20", "nodejs22", @@ -289,6 +308,7 @@ "type": "string" }, "source": { + "description": "The directory containing your functions source code.\nThis directory will be archived and uploaded during deployment.\nFiles outside of this directory will not be included and should not be referenced from your functions code.", "type": "string" } }, @@ -533,12 +553,14 @@ "additionalProperties": false, "properties": { "pinTag": { + "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", "type": "boolean" }, "region": { "type": "string" }, "serviceId": { + "description": "The ID of the Cloud Run service to rewrite to.", "type": "string" } }, @@ -643,12 +665,14 @@ "additionalProperties": false, "properties": { "pinTag": { + "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", "type": "boolean" }, "region": { "type": "string" }, "serviceId": { + "description": "The ID of the Cloud Run service to rewrite to.", "type": "string" } }, @@ -759,12 +783,14 @@ "additionalProperties": false, "properties": { "pinTag": { + "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", "type": "boolean" }, "region": { "type": "string" }, "serviceId": { + "description": "The ID of the Cloud Run service to rewrite to.", "type": "string" } }, @@ -849,7 +875,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -862,7 +889,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { "type": "string" @@ -912,7 +940,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -925,7 +954,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "template": { "type": "string" @@ -938,6 +968,7 @@ }, "StorageSingle": { "additionalProperties": false, + "description": "Deployment options for a single Firebase storage bucket.", "properties": { "postdeploy": { "anyOf": [ @@ -950,7 +981,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -963,9 +995,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the rules files for this Firebase Storage bucket.", "type": "string" }, "target": { @@ -978,8 +1012,10 @@ "type": "object" } }, + "description": "Information about the resources in your Firebase project.\nThis used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start`", "properties": { "$schema": { + "description": "Unused. Included in schema so that the schema can be applied to single files.", "format": "uri", "type": "string" }, @@ -987,14 +1023,17 @@ "anyOf": [ { "additionalProperties": false, + "description": "A single App Hosting deployment configs", "properties": { "alwaysDeployFromSource": { + "description": "If true, this backend will only be deployed from local source, not from source control.", "type": "boolean" }, "backendId": { "type": "string" }, "ignore": { + "description": "A list of file paths to exclude from the archive that is uploaded for this backend.", "items": { "type": "string" }, @@ -1012,16 +1051,20 @@ "type": "object" }, { + "description": "A list of App Hosting deployment configs", "items": { "additionalProperties": false, + "description": "A single App Hosting deployment configs", "properties": { "alwaysDeployFromSource": { + "description": "If true, this backend will only be deployed from local source, not from source control.", "type": "boolean" }, "backendId": { "type": "string" }, "ignore": { + "description": "A list of file paths to exclude from the archive that is uploaded for this backend.", "items": { "type": "string" }, @@ -1040,20 +1083,24 @@ }, "type": "array" } - ] + ], + "description": "The App Hosting backend(s) that should be deployed or emulated." }, "database": { "anyOf": [ { - "$ref": "#/definitions/DatabaseSingle" + "$ref": "#/definitions/DatabaseSingle", + "description": "Deployment options for a single Realtime Database instance." }, { + "description": "Deployment options for a list of Realtime Database instancs.", "items": { "anyOf": [ { "additionalProperties": false, "properties": { "instance": { + "description": "The instance that this rules files is for.", "type": "string" }, "postdeploy": { @@ -1067,7 +1114,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -1080,9 +1128,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "The rules files for this Realtime Database instance.", "type": "string" }, "target": { @@ -1099,6 +1149,7 @@ "additionalProperties": false, "properties": { "instance": { + "description": "The instance that this rules files is for.", "type": "string" }, "postdeploy": { @@ -1112,7 +1163,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -1125,9 +1177,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "The rules files for this Realtime Database instance.", "type": "string" }, "target": { @@ -1144,37 +1198,47 @@ }, "type": "array" } - ] + ], + "description": "The Realtime Database rules that should be deployed or emulated." }, "dataconnect": { "anyOf": [ { - "$ref": "#/definitions/DataConnectSingle" + "$ref": "#/definitions/DataConnectSingle", + "description": "A single Data Connect deployment configs" }, { + "description": "A list of Data Connect deployment configs", "items": { "$ref": "#/definitions/DataConnectSingle" }, "type": "array" } - ] + ], + "description": "The Data Connect service(s) that should be deployed or emulated." }, "emulators": { "additionalProperties": false, + "description": "Hosts, ports, and configuration options for the Firebase Emulator suite.", "properties": { "apphosting": { "additionalProperties": false, + "description": "Config for the App Hosting emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" }, "rootDirectory": { + "description": "The root directory of your app. The start command will ran from this directory.", "type": "string" }, "startCommand": { + "description": "The command that will be run to start your app when emulating your App Hosting backend", "type": "string" }, "startCommandOverride": { @@ -1185,11 +1249,14 @@ }, "auth": { "additionalProperties": false, + "description": "Config for the Auth emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1197,11 +1264,14 @@ }, "database": { "additionalProperties": false, + "description": "Config for the Realtime Database emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1209,20 +1279,26 @@ }, "dataconnect": { "additionalProperties": false, + "description": "Config for the Data Connect emulator.", "properties": { "dataDir": { + "description": "The directory to persist emulator data to. If set, data will be saved between runs automatically.\nIf the --import flag is used, the current data will be overwritten by the imported data.", "type": "string" }, "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" }, "postgresHost": { + "description": "Host for the Postgres database that backs the Data Connect emulator.", "type": "string" }, "postgresPort": { + "description": "Port for the Postgres database that backs the Data Connect emulator.", "type": "number" } }, @@ -1230,27 +1306,34 @@ }, "eventarc": { "additionalProperties": false, + "description": "Config for the EventArc emulator.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, "type": "object" }, "extensions": { + "description": "Placeholder - the Extensions emulator has no configuration options.", "properties": {}, "type": "object" }, "firestore": { "additionalProperties": false, + "description": "Config for the Firestore emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" }, "websocketPort": { @@ -1259,25 +1342,16 @@ }, "type": "object" }, - "functions": { - "additionalProperties": false, - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "number" - } - }, - "type": "object" - }, "hosting": { "additionalProperties": false, + "description": "Config for the Firebase Hosting emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1285,11 +1359,14 @@ }, "hub": { "additionalProperties": false, + "description": "Config for the emulator suite hub.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1297,11 +1374,14 @@ }, "logging": { "additionalProperties": false, + "description": "Config for the logging emulator.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1309,26 +1389,33 @@ }, "pubsub": { "additionalProperties": false, + "description": "Config for the Pub/Sub emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, "type": "object" }, "singleProjectMode": { + "description": "If true, the Emulator Suite will only allow a single project to be used at a time.", "type": "boolean" }, "storage": { "additionalProperties": false, + "description": "Config for the Firebase Storage emulator", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1336,11 +1423,14 @@ }, "tasks": { "additionalProperties": false, + "description": "Config for the Cloud Tasks emulator.", "properties": { "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1348,14 +1438,18 @@ }, "ui": { "additionalProperties": false, + "description": "Config for the Emulator UI.", "properties": { "enabled": { + "description": "If false, the Emulator UI will not be served.", "type": "boolean" }, "host": { + "description": "The host that this emulator will serve on.", "type": "string" }, "port": { + "description": "The port that this emulator will serve on.", "type": "number" } }, @@ -1365,23 +1459,28 @@ "type": "object" }, "extensions": { - "$ref": "#/definitions/ExtensionsConfig" + "$ref": "#/definitions/ExtensionsConfig", + "description": "The Firebase Extension(s) that should be deployed or emulated." }, "firestore": { "anyOf": [ { - "$ref": "#/definitions/FirestoreSingle" + "$ref": "#/definitions/FirestoreSingle", + "description": "Deployment options for a single Firestore database." }, { + "description": "Deployment options for a list of Firestore databases.", "items": { "anyOf": [ { "additionalProperties": false, "properties": { "database": { + "description": "The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.", "type": "string" }, "indexes": { + "description": "Path to the firestore indexes file for this database", "type": "string" }, "postdeploy": { @@ -1395,7 +1494,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -1408,9 +1508,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the firestore rules file for this database", "type": "string" }, "target": { @@ -1426,9 +1528,11 @@ "additionalProperties": false, "properties": { "database": { + "description": "The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.", "type": "string" }, "indexes": { + "description": "Path to the firestore indexes file for this database", "type": "string" }, "postdeploy": { @@ -1442,7 +1546,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -1455,9 +1560,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the firestore rules file for this database", "type": "string" }, "target": { @@ -1473,7 +1580,8 @@ }, "type": "array" } - ] + ], + "description": "The Firestore rules and indexes that should be deployed or emulated." }, "functions": { "anyOf": [ @@ -1486,7 +1594,8 @@ }, "type": "array" } - ] + ], + "description": "The Cloud Functions for Firebase that should be deployed or emulated." }, "hosting": { "anyOf": [ @@ -1547,7 +1656,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -1560,7 +1670,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { "type": "string" @@ -1646,7 +1757,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -1659,7 +1771,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { "type": "string" @@ -1698,21 +1811,26 @@ }, "type": "array" } - ] + ], + "description": "The Firebase Hosting site(s) that should be deployed or emulated." }, "remoteconfig": { - "$ref": "#/definitions/RemoteConfigConfig" + "$ref": "#/definitions/RemoteConfigConfig", + "description": "The Remote Config template(s) used by this project." }, "storage": { "anyOf": [ { - "$ref": "#/definitions/StorageSingle" + "$ref": "#/definitions/StorageSingle", + "description": "Deployment options for a single Firebase storage bucket." }, { + "description": "Deployment options for multiple Firebase storage buckets.", "items": { "additionalProperties": false, "properties": { "bucket": { + "description": "The Firebase Storage bucket that this config is for.", "type": "string" }, "postdeploy": { @@ -1726,7 +1844,8 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran after this product is deployed." }, "predeploy": { "anyOf": [ @@ -1739,9 +1858,11 @@ { "type": "string" } - ] + ], + "description": "A script or list of scripts that will be ran before this product is deployed." }, "rules": { + "description": "Path to the rules files for this Firebase Storage bucket.", "type": "string" }, "target": { @@ -1756,7 +1877,8 @@ }, "type": "array" } - ] + ], + "description": "The Firebase Storage rules that should be deployed or emulated." } }, "type": "object" From 15a3ad7bbe9290d7e0fd3fea661cb6159f99338c Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Mon, 16 Jun 2025 19:46:20 -0700 Subject: [PATCH 04/10] Some more descriptions --- schema/docs/firebase-config.md | 190 ++++++++++++++++++++++++++++-- schema/firebase-config.json | 117 ++++++++++++++++-- scripts/docs-gen/index.js | 4 +- src/firebaseConfig.ts | 209 +++++++++++++++++++++++++-------- 4 files changed, 450 insertions(+), 70 deletions(-) diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md index 0e78eb2a2bb..3fce5b7f617 100644 --- a/schema/docs/firebase-config.md +++ b/schema/docs/firebase-config.md @@ -2298,6 +2298,10 @@ Files outside of this directory will not be included and should not be reference
DescriptionPath to the rules files for this Firebase Storage bucket.
TypeString
+ + + + @@ -2339,6 +2343,10 @@ Files outside of this directory will not be included and should not be reference
DescriptionDeployment options for a single Firebase Hosting site.
TypeObject
+ + + + @@ -2613,6 +2621,10 @@ Defaults to true for {@link https.CallableFunction} and false otherwise.
DescriptionOptions for this sites web frameworks backend.
TypeObject
+ + + + @@ -2699,6 +2711,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA list of secrets used in this app.
TypeArray
+ + + + @@ -2712,6 +2728,12 @@ HTTPS functions can specify a higher timeout.
DescriptionA list of extra headers to send when serving specific paths on this site.
TypeArray
+ + + + @@ -2724,6 +2746,10 @@ HTTPS functions can specify a higher timeout.
DescriptionInternationalization config for this site. +See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites +for instructions on how to enable interntionalization for your site.
TypeObject
+ + + + @@ -2738,6 +2764,10 @@ HTTPS functions can specify a higher timeout.
DescriptionThe directory containing internationalization rewrites.
TypeString
+ + + + @@ -2837,6 +2867,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA list of paths or globs within the source directory that should not be included in the uploaded archive.
TypeArray
+ + + + @@ -2850,6 +2884,10 @@ HTTPS functions can specify a higher timeout.
DescriptionWhether this site should publically available.
TypeString
+ + + + @@ -2863,6 +2901,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA list of redirects for this site.
TypeArray
+ + + + @@ -2876,6 +2918,10 @@ HTTPS functions can specify a higher timeout.
DescriptionA list o rewrites for this site.
TypeArray
+ + + + @@ -2889,6 +2935,10 @@ HTTPS functions can specify a higher timeout.
DescriptionThe site to deploy.
TypeString
+ + + + @@ -2902,6 +2952,11 @@ HTTPS functions can specify a higher timeout.
DescriptionPath to the directory containing this site's source code. This will be archived and uploaded during deployment.
TypeString
+ + + + @@ -2929,6 +2984,10 @@ HTTPS functions can specify a higher timeout.
DescriptionThe deploy target to deploy. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.
TypeString
+ + + + @@ -3059,6 +3118,10 @@ HTTPS functions can specify a higher timeout.
DescriptionDeployment options for a list of Firebase Hosting sites.
TypeArray
+ + + + @@ -3216,6 +3279,11 @@ HTTPS functions can specify a higher timeout.
DescriptionA path to a CJSON file containing a Remote Config template.
TypeString
Required
+ + + + @@ -3366,6 +3434,11 @@ HTTPS functions can specify a higher timeout.
DescriptionThe deploy target to these Storage rules to. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.
TypeString
+ + + + @@ -3612,6 +3685,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "secrets": { + "description": "A list of secrets used in this app.", "items": { "type": "string" }, @@ -3707,6 +3781,7 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "headers": { @@ -3714,9 +3789,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "key": { + "description": "The header to set.", "type": "string" }, "value": { + "description": "The value to set this header to.", "type": "string" } }, @@ -3743,9 +3820,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "key": { + "description": "The header to set.", "type": "string" }, "value": { + "description": "The value to set this header to.", "type": "string" } }, @@ -3758,6 +3837,7 @@ HTTPS functions can specify a higher timeout. "type": "array" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -3775,9 +3855,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "key": { + "description": "The header to set.", "type": "string" }, "value": { + "description": "The value to set this header to.", "type": "string" } }, @@ -3790,6 +3872,7 @@ HTTPS functions can specify a higher timeout. "type": "array" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -3799,7 +3882,8 @@ HTTPS functions can specify a higher timeout. ], "type": "object" } - ] + ], + "description": "Extra headers that should be sent when serving this path." }, "HostingRedirects": { "anyOf": [ @@ -3807,12 +3891,19 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "destination": { + "description": "The destination to redirect to.", "type": "string" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "type": { + "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", + "enum": [ + 301, + 302 + ], "type": "number" } }, @@ -3826,12 +3917,19 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "destination": { + "description": "The destination to redirect to.", "type": "string" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" }, "type": { + "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", + "enum": [ + 301, + 302 + ], "type": "number" } }, @@ -3845,12 +3943,19 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "destination": { + "description": "The destination to redirect to.", "type": "string" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" }, "type": { + "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", + "enum": [ + 301, + 302 + ], "type": "number" } }, @@ -3860,7 +3965,8 @@ HTTPS functions can specify a higher timeout. ], "type": "object" } - ] + ], + "description": "URL redirects for a hosting site. Use these to prevent broken links when moving pages." }, "HostingRewrites": { "anyOf": [ @@ -3871,6 +3977,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" } }, @@ -3887,6 +3994,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "region": { @@ -3906,9 +4014,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "functionId": { + "description": "The ID of the Cloud Function to rewrite to.", "type": "string" }, "pinTag": { + "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", "type": "boolean" }, "region": { @@ -3921,6 +4031,7 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" } }, @@ -3934,13 +4045,14 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "run": { "additionalProperties": false, "properties": { "pinTag": { - "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", + "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", "type": "boolean" }, "region": { @@ -3970,6 +4082,7 @@ HTTPS functions can specify a higher timeout. "type": "boolean" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" } }, @@ -3986,6 +4099,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -4005,6 +4119,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -4021,9 +4136,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "functionId": { + "description": "The ID of the Cloud Function to rewrite to.", "type": "string" }, "pinTag": { + "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", "type": "boolean" }, "region": { @@ -4036,6 +4153,7 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -4052,7 +4170,7 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "pinTag": { - "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", + "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", "type": "boolean" }, "region": { @@ -4069,6 +4187,7 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -4085,6 +4204,7 @@ HTTPS functions can specify a higher timeout. "type": "boolean" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -4101,6 +4221,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -4117,6 +4238,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" }, "region": { @@ -4136,9 +4258,11 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "functionId": { + "description": "The ID of the Cloud Function to rewrite to.", "type": "string" }, "pinTag": { + "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", "type": "boolean" }, "region": { @@ -4151,6 +4275,7 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -4164,13 +4289,14 @@ HTTPS functions can specify a higher timeout. "additionalProperties": false, "properties": { "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" }, "run": { "additionalProperties": false, "properties": { "pinTag": { - "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", + "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", "type": "boolean" }, "region": { @@ -4200,6 +4326,7 @@ HTTPS functions can specify a higher timeout. "type": "boolean" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -4209,10 +4336,12 @@ HTTPS functions can specify a higher timeout. ], "type": "object" } - ] + ], + "description": "Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service." }, "HostingSingle": { "additionalProperties": false, + "description": "Deployment options for a single Firebase Hosting site.", "properties": { "appAssociation": { "enum": [ @@ -4225,9 +4354,11 @@ HTTPS functions can specify a higher timeout. "type": "boolean" }, "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions" + "$ref": "#/definitions/FrameworksBackendOptions", + "description": "Options for this sites web frameworks backend." }, "headers": { + "description": "A list of extra headers to send when serving specific paths on this site.", "items": { "$ref": "#/definitions/HostingHeaders" }, @@ -4235,8 +4366,10 @@ HTTPS functions can specify a higher timeout. }, "i18n": { "additionalProperties": false, + "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", "properties": { "root": { + "description": "The directory containing internationalization rewrites.", "type": "string" } }, @@ -4246,6 +4379,7 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "ignore": { + "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", "items": { "type": "string" }, @@ -4280,27 +4414,33 @@ HTTPS functions can specify a higher timeout. "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { + "description": "Whether this site should publically available.", "type": "string" }, "redirects": { + "description": "A list of redirects for this site.", "items": { "$ref": "#/definitions/HostingRedirects" }, "type": "array" }, "rewrites": { + "description": "A list o rewrites for this site.", "items": { "$ref": "#/definitions/HostingRewrites" }, "type": "array" }, "site": { + "description": "The site to deploy.", "type": "string" }, "source": { + "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", "type": "string" }, "target": { + "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" }, "trailingSlash": { @@ -4315,6 +4455,7 @@ HTTPS functions can specify a higher timeout. }, "RemoteConfigConfig": { "additionalProperties": false, + "description": "A Remote Config template to deploy.", "properties": { "postdeploy": { "anyOf": [ @@ -4345,6 +4486,7 @@ HTTPS functions can specify a higher timeout. "description": "A script or list of scripts that will be ran before this product is deployed." }, "template": { + "description": "A path to a CJSON file containing a Remote Config template.", "type": "string" } }, @@ -4390,6 +4532,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "target": { + "description": "The deploy target to these Storage rules to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, @@ -4903,6 +5046,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "target": { + "description": "The deploy target these rules and indexes should be deployed to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, @@ -4955,6 +5099,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "target": { + "description": "The deploy target these rules and indexes should be deployed to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, @@ -4987,9 +5132,11 @@ HTTPS functions can specify a higher timeout. "hosting": { "anyOf": [ { - "$ref": "#/definitions/HostingSingle" + "$ref": "#/definitions/HostingSingle", + "description": "Deployment options for a single Firebase Hosting site." }, { + "description": "Deployment options for a list of Firebase Hosting sites.", "items": { "anyOf": [ { @@ -5006,9 +5153,11 @@ HTTPS functions can specify a higher timeout. "type": "boolean" }, "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions" + "$ref": "#/definitions/FrameworksBackendOptions", + "description": "Options for this sites web frameworks backend." }, "headers": { + "description": "A list of extra headers to send when serving specific paths on this site.", "items": { "$ref": "#/definitions/HostingHeaders" }, @@ -5016,8 +5165,10 @@ HTTPS functions can specify a higher timeout. }, "i18n": { "additionalProperties": false, + "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", "properties": { "root": { + "description": "The directory containing internationalization rewrites.", "type": "string" } }, @@ -5027,6 +5178,7 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "ignore": { + "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", "items": { "type": "string" }, @@ -5061,27 +5213,33 @@ HTTPS functions can specify a higher timeout. "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { + "description": "Whether this site should publically available.", "type": "string" }, "redirects": { + "description": "A list of redirects for this site.", "items": { "$ref": "#/definitions/HostingRedirects" }, "type": "array" }, "rewrites": { + "description": "A list o rewrites for this site.", "items": { "$ref": "#/definitions/HostingRewrites" }, "type": "array" }, "site": { + "description": "The site to deploy", "type": "string" }, "source": { + "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", "type": "string" }, "target": { + "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" }, "trailingSlash": { @@ -5107,9 +5265,11 @@ HTTPS functions can specify a higher timeout. "type": "boolean" }, "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions" + "$ref": "#/definitions/FrameworksBackendOptions", + "description": "Options for this sites web frameworks backend." }, "headers": { + "description": "A list of extra headers to send when serving specific paths on this site.", "items": { "$ref": "#/definitions/HostingHeaders" }, @@ -5117,8 +5277,10 @@ HTTPS functions can specify a higher timeout. }, "i18n": { "additionalProperties": false, + "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", "properties": { "root": { + "description": "The directory containing internationalization rewrites.", "type": "string" } }, @@ -5128,6 +5290,7 @@ HTTPS functions can specify a higher timeout. "type": "object" }, "ignore": { + "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", "items": { "type": "string" }, @@ -5162,27 +5325,33 @@ HTTPS functions can specify a higher timeout. "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { + "description": "Whether this site should publically available.", "type": "string" }, "redirects": { + "description": "A list of redirects for this site.", "items": { "$ref": "#/definitions/HostingRedirects" }, "type": "array" }, "rewrites": { + "description": "A list o rewrites for this site.", "items": { "$ref": "#/definitions/HostingRewrites" }, "type": "array" }, "site": { + "description": "The site to deploy", "type": "string" }, "source": { + "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", "type": "string" }, "target": { + "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" }, "trailingSlash": { @@ -5253,6 +5422,7 @@ HTTPS functions can specify a higher timeout. "type": "string" }, "target": { + "description": "The deploy target to these Storage rules to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, diff --git a/schema/firebase-config.json b/schema/firebase-config.json index 2b2fe5f9c57..6bf07b098c0 100644 --- a/schema/firebase-config.json +++ b/schema/firebase-config.json @@ -225,6 +225,7 @@ "type": "string" }, "secrets": { + "description": "A list of secrets used in this app.", "items": { "type": "string" }, @@ -320,6 +321,7 @@ "additionalProperties": false, "properties": { "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "headers": { @@ -327,9 +329,11 @@ "additionalProperties": false, "properties": { "key": { + "description": "The header to set.", "type": "string" }, "value": { + "description": "The value to set this header to.", "type": "string" } }, @@ -356,9 +360,11 @@ "additionalProperties": false, "properties": { "key": { + "description": "The header to set.", "type": "string" }, "value": { + "description": "The value to set this header to.", "type": "string" } }, @@ -371,6 +377,7 @@ "type": "array" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -388,9 +395,11 @@ "additionalProperties": false, "properties": { "key": { + "description": "The header to set.", "type": "string" }, "value": { + "description": "The value to set this header to.", "type": "string" } }, @@ -403,6 +412,7 @@ "type": "array" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -412,7 +422,8 @@ ], "type": "object" } - ] + ], + "description": "Extra headers that should be sent when serving this path." }, "HostingRedirects": { "anyOf": [ @@ -420,12 +431,19 @@ "additionalProperties": false, "properties": { "destination": { + "description": "The destination to redirect to.", "type": "string" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "type": { + "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", + "enum": [ + 301, + 302 + ], "type": "number" } }, @@ -439,12 +457,19 @@ "additionalProperties": false, "properties": { "destination": { + "description": "The destination to redirect to.", "type": "string" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" }, "type": { + "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", + "enum": [ + 301, + 302 + ], "type": "number" } }, @@ -458,12 +483,19 @@ "additionalProperties": false, "properties": { "destination": { + "description": "The destination to redirect to.", "type": "string" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" }, "type": { + "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", + "enum": [ + 301, + 302 + ], "type": "number" } }, @@ -473,7 +505,8 @@ ], "type": "object" } - ] + ], + "description": "URL redirects for a hosting site. Use these to prevent broken links when moving pages." }, "HostingRewrites": { "anyOf": [ @@ -484,6 +517,7 @@ "type": "string" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" } }, @@ -500,6 +534,7 @@ "type": "string" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "region": { @@ -519,9 +554,11 @@ "additionalProperties": false, "properties": { "functionId": { + "description": "The ID of the Cloud Function to rewrite to.", "type": "string" }, "pinTag": { + "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", "type": "boolean" }, "region": { @@ -534,6 +571,7 @@ "type": "object" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" } }, @@ -547,13 +585,14 @@ "additionalProperties": false, "properties": { "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" }, "run": { "additionalProperties": false, "properties": { "pinTag": { - "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", + "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", "type": "boolean" }, "region": { @@ -583,6 +622,7 @@ "type": "boolean" }, "glob": { + "description": "A glob pattern describing the paths that this setting should apply to.", "type": "string" } }, @@ -599,6 +639,7 @@ "type": "string" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -618,6 +659,7 @@ "type": "string" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -634,9 +676,11 @@ "additionalProperties": false, "properties": { "functionId": { + "description": "The ID of the Cloud Function to rewrite to.", "type": "string" }, "pinTag": { + "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", "type": "boolean" }, "region": { @@ -649,6 +693,7 @@ "type": "object" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -665,7 +710,7 @@ "additionalProperties": false, "properties": { "pinTag": { - "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", + "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", "type": "boolean" }, "region": { @@ -682,6 +727,7 @@ "type": "object" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -698,6 +744,7 @@ "type": "boolean" }, "source": { + "description": "A file path that this setting should apply to.", "type": "string" } }, @@ -714,6 +761,7 @@ "type": "string" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -730,6 +778,7 @@ "type": "string" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" }, "region": { @@ -749,9 +798,11 @@ "additionalProperties": false, "properties": { "functionId": { + "description": "The ID of the Cloud Function to rewrite to.", "type": "string" }, "pinTag": { + "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", "type": "boolean" }, "region": { @@ -764,6 +815,7 @@ "type": "object" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -777,13 +829,14 @@ "additionalProperties": false, "properties": { "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" }, "run": { "additionalProperties": false, "properties": { "pinTag": { - "description": "If true, traffic will be pinned to the currently running version of the Cloud Run service.", + "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", "type": "boolean" }, "region": { @@ -813,6 +866,7 @@ "type": "boolean" }, "regex": { + "description": "A regex pattern that matches the paths that this setting should apply to. *", "type": "string" } }, @@ -822,10 +876,12 @@ ], "type": "object" } - ] + ], + "description": "Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service." }, "HostingSingle": { "additionalProperties": false, + "description": "Deployment options for a single Firebase Hosting site.", "properties": { "appAssociation": { "enum": [ @@ -838,9 +894,11 @@ "type": "boolean" }, "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions" + "$ref": "#/definitions/FrameworksBackendOptions", + "description": "Options for this sites web frameworks backend." }, "headers": { + "description": "A list of extra headers to send when serving specific paths on this site.", "items": { "$ref": "#/definitions/HostingHeaders" }, @@ -848,8 +906,10 @@ }, "i18n": { "additionalProperties": false, + "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", "properties": { "root": { + "description": "The directory containing internationalization rewrites.", "type": "string" } }, @@ -859,6 +919,7 @@ "type": "object" }, "ignore": { + "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", "items": { "type": "string" }, @@ -893,27 +954,33 @@ "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { + "description": "Whether this site should publically available.", "type": "string" }, "redirects": { + "description": "A list of redirects for this site.", "items": { "$ref": "#/definitions/HostingRedirects" }, "type": "array" }, "rewrites": { + "description": "A list o rewrites for this site.", "items": { "$ref": "#/definitions/HostingRewrites" }, "type": "array" }, "site": { + "description": "The site to deploy.", "type": "string" }, "source": { + "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", "type": "string" }, "target": { + "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" }, "trailingSlash": { @@ -928,6 +995,7 @@ }, "RemoteConfigConfig": { "additionalProperties": false, + "description": "A Remote Config template to deploy.", "properties": { "postdeploy": { "anyOf": [ @@ -958,6 +1026,7 @@ "description": "A script or list of scripts that will be ran before this product is deployed." }, "template": { + "description": "A path to a CJSON file containing a Remote Config template.", "type": "string" } }, @@ -1003,6 +1072,7 @@ "type": "string" }, "target": { + "description": "The deploy target to these Storage rules to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, @@ -1516,6 +1586,7 @@ "type": "string" }, "target": { + "description": "The deploy target these rules and indexes should be deployed to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, @@ -1568,6 +1639,7 @@ "type": "string" }, "target": { + "description": "The deploy target these rules and indexes should be deployed to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, @@ -1600,9 +1672,11 @@ "hosting": { "anyOf": [ { - "$ref": "#/definitions/HostingSingle" + "$ref": "#/definitions/HostingSingle", + "description": "Deployment options for a single Firebase Hosting site." }, { + "description": "Deployment options for a list of Firebase Hosting sites.", "items": { "anyOf": [ { @@ -1619,9 +1693,11 @@ "type": "boolean" }, "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions" + "$ref": "#/definitions/FrameworksBackendOptions", + "description": "Options for this sites web frameworks backend." }, "headers": { + "description": "A list of extra headers to send when serving specific paths on this site.", "items": { "$ref": "#/definitions/HostingHeaders" }, @@ -1629,8 +1705,10 @@ }, "i18n": { "additionalProperties": false, + "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", "properties": { "root": { + "description": "The directory containing internationalization rewrites.", "type": "string" } }, @@ -1640,6 +1718,7 @@ "type": "object" }, "ignore": { + "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", "items": { "type": "string" }, @@ -1674,27 +1753,33 @@ "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { + "description": "Whether this site should publically available.", "type": "string" }, "redirects": { + "description": "A list of redirects for this site.", "items": { "$ref": "#/definitions/HostingRedirects" }, "type": "array" }, "rewrites": { + "description": "A list o rewrites for this site.", "items": { "$ref": "#/definitions/HostingRewrites" }, "type": "array" }, "site": { + "description": "The site to deploy", "type": "string" }, "source": { + "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", "type": "string" }, "target": { + "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" }, "trailingSlash": { @@ -1720,9 +1805,11 @@ "type": "boolean" }, "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions" + "$ref": "#/definitions/FrameworksBackendOptions", + "description": "Options for this sites web frameworks backend." }, "headers": { + "description": "A list of extra headers to send when serving specific paths on this site.", "items": { "$ref": "#/definitions/HostingHeaders" }, @@ -1730,8 +1817,10 @@ }, "i18n": { "additionalProperties": false, + "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", "properties": { "root": { + "description": "The directory containing internationalization rewrites.", "type": "string" } }, @@ -1741,6 +1830,7 @@ "type": "object" }, "ignore": { + "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", "items": { "type": "string" }, @@ -1775,27 +1865,33 @@ "description": "A script or list of scripts that will be ran before this product is deployed." }, "public": { + "description": "Whether this site should publically available.", "type": "string" }, "redirects": { + "description": "A list of redirects for this site.", "items": { "$ref": "#/definitions/HostingRedirects" }, "type": "array" }, "rewrites": { + "description": "A list o rewrites for this site.", "items": { "$ref": "#/definitions/HostingRewrites" }, "type": "array" }, "site": { + "description": "The site to deploy", "type": "string" }, "source": { + "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", "type": "string" }, "target": { + "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" }, "trailingSlash": { @@ -1866,6 +1962,7 @@ "type": "string" }, "target": { + "description": "The deploy target to these Storage rules to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", "type": "string" } }, diff --git a/scripts/docs-gen/index.js b/scripts/docs-gen/index.js index fe95b7436a6..33496e3b1bf 100644 --- a/scripts/docs-gen/index.js +++ b/scripts/docs-gen/index.js @@ -1,7 +1,7 @@ const JsonSchemaStaticDocs = require("json-schema-static-docs"); (async () => { - let jsonSchemaStaticDocs = new JsonSchemaStaticDocs({ + const jsonSchemaStaticDocs = new JsonSchemaStaticDocs({ inputPath: "../../schema", outputPath: "../../schema/docs", ajvOptions: { @@ -10,4 +10,4 @@ const JsonSchemaStaticDocs = require("json-schema-static-docs"); }); await jsonSchemaStaticDocs.generate(); console.log("Documents generated."); -})(); \ No newline at end of file +})(); diff --git a/src/firebaseConfig.ts b/src/firebaseConfig.ts index 50614deec2a..ab39bcf1e28 100644 --- a/src/firebaseConfig.ts +++ b/src/firebaseConfig.ts @@ -1,7 +1,9 @@ // // NOTE: // The contents of this file are used to generate the JSON Schema documents in -// the schema/ directory. After changing this file you will need to run +// the schema/ directory. +// Comments in /** */ this file become the description in the JSON schema - please treat them as public documentation. +// After changing this file you will need to run // 'npm run generate:json-schema' to regenerate the schema files. // @@ -52,7 +54,6 @@ type DatabaseMultiple = ({ */ rules: string; } & RequireAtLeastOne<{ - /** * The instance that this rules files is for. */ @@ -70,8 +71,8 @@ type FirestoreSingle = { */ database?: string; /** - * The region of the Firestore database to deploy. Required when 'database' is set. - */ + * The region of the Firestore database to deploy. Required when 'database' is set. + */ location?: string; /** * Path to the firestore rules file @@ -100,23 +101,63 @@ type FirestoreMultiple = ({ * The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. */ database: string; + /** + * The deploy target these rules and indexes should be deployed to. + * See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. + */ target: string; }> & Deployable)[]; -export type HostingSource = { glob: string } | { source: string } | { regex: string }; +export type HostingSource = + | { + /** A glob pattern describing the paths that this setting should apply to. */ + glob: string; + } + | { + /** A file path that this setting should apply to.*/ + source: string; + } + | { + /** A regex pattern that matches the paths that this setting should apply to. **/ + regex: string; + }; +/** + * URL redirects for a hosting site. Use these to prevent broken links when moving pages. + */ export type HostingRedirects = HostingSource & { + /** + * The destination to redirect to. + */ destination: string; - type?: number; + /** + * The type of redirect. + * Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) + */ + type?: 301 | 302; }; +/** + * A simple rewrite from one path to another. + */ export type DestinationRewrite = { destination: string }; +/** + * DEPRECATED: A Hosting rewrite to a Cloud Function. + */ export type LegacyFunctionsRewrite = { function: string; region?: string }; +/** + * A Hosting rewrite to a Cloud Function. + */ export type FunctionsRewrite = { function: { + /** The ID of the Cloud Function to rewrite to. */ functionId: string; + //* * The region of the Cloud Function to rewrite to. */ region?: string; + /** + * If true, the rewrite will be pinned to the currently running version of the Cloud Function. + * */ pinTag?: boolean; }; }; @@ -127,13 +168,20 @@ export type RunRewrite = { run: { /** The ID of the Cloud Run service to rewrite to. */ serviceId: string; - //** The region of the Cloud Run service to rewrite to. */ + //* * The region of the Cloud Run service to rewrite to. */ region?: string; - /** If true, traffic will be pinned to the currently running version of the Cloud Run service. */ + /** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. */ pinTag?: boolean; }; }; + +/** + * DEPRECATED: A Hosting rewrite ot a Firebase Dynamic Link. + */ export type DynamicLinksRewrite = { dynamicLinks: boolean }; +/** + * Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. + */ export type HostingRewrites = HostingSource & ( | DestinationRewrite @@ -143,9 +191,18 @@ export type HostingRewrites = HostingSource & | DynamicLinksRewrite ); +/** + * Extra headers that should be sent when serving this path. + */ export type HostingHeaders = HostingSource & { headers: { + /** + * The header to set. + */ key: string; + /** + * The value to set this header to. + */ value: string; }[]; }; @@ -165,6 +222,7 @@ interface FrameworksBackendOptions extends HttpsOptions { vpcConnectorEgressSettings?: VpcEgressSetting; serviceAccount?: string; ingressSettings?: IngressSetting; + /** A list of secrets used in this app. */ secrets?: string[]; // Only allow a single region to be specified region?: string; @@ -173,36 +231,78 @@ interface FrameworksBackendOptions extends HttpsOptions { } export type HostingBase = { + /** + * Whether this site should publically available. + */ public?: string; + /** + * Path to the directory containing this site's source code. This will be archived and uploaded during deployment. + */ source?: string; + /** + * A list of paths or globs within the source directory that should not be included in the uploaded archive. + */ ignore?: string[]; appAssociation?: "AUTO" | "NONE"; cleanUrls?: boolean; trailingSlash?: boolean; + /** + * A list of redirects for this site. + */ redirects?: HostingRedirects[]; + /** + * A list o rewrites for this site. + */ rewrites?: HostingRewrites[]; + /** + * A list of extra headers to send when serving specific paths on this site. + */ headers?: HostingHeaders[]; + /** + * Internationalization config for this site. + * See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites + * for instructions on how to enable interntionalization for your site. + */ i18n?: { + /** + * The directory containing internationalization rewrites. + */ root: string; }; + /** + * Options for this sites web frameworks backend. + */ frameworksBackend?: FrameworksBackendOptions; }; +/** + * Deployment options for a single Firebase Hosting site. + */ export type HostingSingle = HostingBase & { + /** + * The site to deploy. + */ site?: string; + /** + * The deploy target to deploy. + * See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. + */ target?: string; } & Deployable; -// N.B. You would expect that a HostingMultiple is a HostingSingle[], but not -// quite. When you only have one hosting object you can omit both `site` and -// `target` because the default site will be looked up and provided for you. -// When you have a list of hosting targets, though, we require all configs -// to specify which site is being targeted. -// If you can assume we've resolved targets, you probably want to use -// HostingResolved, which says you must have site and may have target. +/** + * Deployment options for a list of Firebase Hosting sites. + */ export type HostingMultiple = (HostingBase & RequireAtLeastOne<{ + /** + * The site to deploy + */ site: string; + /** + * The deploy target to deploy. + * See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. + */ target: string; }> & Deployable)[]; @@ -215,6 +315,10 @@ type StorageSingle = { * Path to the rules files for this Firebase Storage bucket. */ rules: string; + /** + * The deploy target to these Storage rules to. + * See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. + */ target?: string; } & Deployable; @@ -230,6 +334,10 @@ type StorageMultiple = ({ * The Firebase Storage bucket that this config is for. */ bucket: string; + /** + * The deploy target to these Storage rules to. + * See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. + */ target?: string; } & Deployable)[]; @@ -280,12 +388,18 @@ export type HostingConfig = HostingSingle | HostingMultiple; */ export type StorageConfig = StorageSingle | StorageMultiple; +/** + * A Remote Config template to deploy. + */ export type RemoteConfigConfig = { + /** + * A path to a CJSON file containing a Remote Config template. + */ template: string; } & Deployable; /** - * Configures the host and port an emulator will be served. If omitted, the emulator suite will + * Configures the host and port an emulator will be served. If omitted, the emulator suite will * automatically discover available ports. */ type EmulatorServingConfig = { @@ -293,11 +407,11 @@ type EmulatorServingConfig = { * The host that this emulator will serve on. */ host?: string; - /** + /** * The port that this emulator will serve on. */ port?: number; -} +}; /** * Hosts, ports, and configuration options for the Firebase Emulator suite. @@ -308,24 +422,23 @@ export type EmulatorsConfig = { */ auth?: EmulatorServingConfig; /** - * Config for the Realtime Database emulator - */ + * Config for the Realtime Database emulator + */ database?: EmulatorServingConfig; /** - * Config for the Firestore emulator - */ + * Config for the Firestore emulator + */ firestore?: EmulatorServingConfig & { websocketPort?: number; }; /** - * Config for the Firebase Hosting emulator - */ + * Config for the Firebase Hosting emulator + */ hosting?: EmulatorServingConfig; /** - * Config for the App Hosting emulator - */ + * Config for the App Hosting emulator + */ apphosting?: EmulatorServingConfig & { - /** The command that will be run to start your app when emulating your App Hosting backend */ startCommand?: string; /** @@ -336,24 +449,24 @@ export type EmulatorsConfig = { rootDirectory?: string; }; /** - * Config for the Pub/Sub emulator - */ - pubsub?: EmulatorServingConfig; + * Config for the Pub/Sub emulator + */ + pubsub?: EmulatorServingConfig; /** - * Config for the Firebase Storage emulator - */ - storage?: EmulatorServingConfig; + * Config for the Firebase Storage emulator + */ + storage?: EmulatorServingConfig; /** - * Config for the logging emulator. - */ + * Config for the logging emulator. + */ logging?: EmulatorServingConfig; /** - * Config for the emulator suite hub. - */ + * Config for the emulator suite hub. + */ hub?: EmulatorServingConfig; /** - * Config for the Emulator UI. - */ + * Config for the Emulator UI. + */ ui?: EmulatorServingConfig & { /** * If false, the Emulator UI will not be served. @@ -365,24 +478,24 @@ export type EmulatorsConfig = { */ extensions?: {}; /** - * Config for the EventArc emulator. - */ + * Config for the EventArc emulator. + */ eventarc?: EmulatorServingConfig; /** * If true, the Emulator Suite will only allow a single project to be used at a time. */ singleProjectMode?: boolean; /** - * Config for the Data Connect emulator. - */ + * Config for the Data Connect emulator. + */ dataconnect?: EmulatorServingConfig & { /** * Host for the Postgres database that backs the Data Connect emulator. */ postgresHost?: string; /** - * Port for the Postgres database that backs the Data Connect emulator. - */ + * Port for the Postgres database that backs the Data Connect emulator. + */ postgresPort?: number; /** * The directory to persist emulator data to. If set, data will be saved between runs automatically. @@ -391,8 +504,8 @@ export type EmulatorsConfig = { dataDir?: string; }; /** - * Config for the Cloud Tasks emulator. - */ + * Config for the Cloud Tasks emulator. + */ tasks?: EmulatorServingConfig; }; @@ -400,7 +513,7 @@ export type EmulatorsConfig = { * The Firebase Extensions that should be deployed to this project. * This is a map of instance ID to extension reference (/@)- ie: * "my-firestore-export": "firebase/firestore-bigquery-export@1.2.3" - * + * * Version can also be a semver range. */ export type ExtensionsConfig = Record; From 292050351b798c80f9333bd212680fa09e7b2cc3 Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Tue, 17 Jun 2025 07:02:05 -0700 Subject: [PATCH 05/10] Testing out json-schema-for-humans --- schema/connector-yaml.json | 1 + schema/dataconnect-yaml.json | 1 + schema/docs/connector-yaml.md | 1088 ++-- schema/docs/dataconnect-yaml.md | 485 +- schema/docs/extension-yaml.md | 2887 ++++---- schema/docs/firebase-config.md | 10496 ++++++++++++++++++------------ schema/docs/index.md | 5 - schema/extension-yaml.json | 1 + 8 files changed, 8199 insertions(+), 6765 deletions(-) delete mode 100644 schema/docs/index.md diff --git a/schema/connector-yaml.json b/schema/connector-yaml.json index 744dfe8390a..13ba62b5281 100644 --- a/schema/connector-yaml.json +++ b/schema/connector-yaml.json @@ -1,6 +1,7 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "connector.yaml", + "description": "connector.yaml is how you configure a connector for your Firebase Data Connect service.", "additionalProperties": false, "definitions": { "javascriptSdk": { diff --git a/schema/dataconnect-yaml.json b/schema/dataconnect-yaml.json index 18f7b1da9ab..a5cf3e20cb3 100644 --- a/schema/dataconnect-yaml.json +++ b/schema/dataconnect-yaml.json @@ -1,6 +1,7 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "dataconnect.yaml", + "description": "dataconnect.yaml is how you configure a Firebase Data Connect service.", "additionalProperties": false, "definitions": { "postgresql": { diff --git a/schema/docs/connector-yaml.md b/schema/docs/connector-yaml.md index 23b43eb46af..2a4e006483f 100644 --- a/schema/docs/connector-yaml.md +++ b/schema/docs/connector-yaml.md @@ -1,765 +1,583 @@ +# Schema Docs + +- [1. [Optional] Property root > connectorId](#connectorId) +- [2. [Optional] Property root > generate](#generate) + - [2.1. [Optional] Property root > generate > javascriptSdk](#generate_javascriptSdk) + - [2.1.1. Property `root > generate > javascriptSdk > oneOf > javascriptSdk`](#generate_javascriptSdk_oneOf_i0) + - [2.1.1.1. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > outputDir](#generate_javascriptSdk_oneOf_i0_outputDir) + - [2.1.1.2. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > package](#generate_javascriptSdk_oneOf_i0_package) + - [2.1.1.3. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir](#generate_javascriptSdk_oneOf_i0_packageJSONDir) + - [2.1.2. Property `root > generate > javascriptSdk > oneOf > item 1`](#generate_javascriptSdk_oneOf_i1) + - [2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk](#autogenerated_heading_2) + - [2.2. [Optional] Property root > generate > dartSdk](#generate_dartSdk) + - [2.2.1. Property `root > generate > dartSdk > oneOf > dartSdk`](#generate_dartSdk_oneOf_i0) + - [2.2.1.1. [Optional] Property root > generate > dartSdk > oneOf > item 0 > outputDir](#generate_dartSdk_oneOf_i0_outputDir) + - [2.2.1.2. [Optional] Property root > generate > dartSdk > oneOf > item 0 > package](#generate_dartSdk_oneOf_i0_package) + - [2.2.2. Property `root > generate > dartSdk > oneOf > item 1`](#generate_dartSdk_oneOf_i1) + - [2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk](#autogenerated_heading_3) + - [2.3. [Optional] Property root > generate > kotlinSdk](#generate_kotlinSdk) + - [2.3.1. Property `root > generate > kotlinSdk > oneOf > kotlinSdk`](#generate_kotlinSdk_oneOf_i0) + - [2.3.1.1. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > outputDir](#generate_kotlinSdk_oneOf_i0_outputDir) + - [2.3.1.2. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > package](#generate_kotlinSdk_oneOf_i0_package) + - [2.3.2. Property `root > generate > kotlinSdk > oneOf > item 1`](#generate_kotlinSdk_oneOf_i1) + - [2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk](#autogenerated_heading_4) + - [2.4. [Optional] Property root > generate > swiftSdk](#generate_swiftSdk) + - [2.4.1. Property `root > generate > swiftSdk > oneOf > swiftSdk`](#generate_swiftSdk_oneOf_i0) + - [2.4.1.1. [Optional] Property root > generate > swiftSdk > oneOf > item 0 > outputDir](#generate_swiftSdk_oneOf_i0_outputDir) + - [2.4.2. Property `root > generate > swiftSdk > oneOf > item 1`](#generate_swiftSdk_oneOf_i1) + - [2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk](#autogenerated_heading_5) + - [2.5. [Optional] Property root > generate > llmTools](#generate_llmTools) + - [2.5.1. Property `root > generate > llmTools > oneOf > llmTools`](#generate_llmTools_oneOf_i0) + - [2.5.1.1. [Optional] Property root > generate > llmTools > oneOf > item 0 > outputFile](#generate_llmTools_oneOf_i0_outputFile) + - [2.5.2. Property `root > generate > llmTools > oneOf > item 1`](#generate_llmTools_oneOf_i1) + - [2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools](#autogenerated_heading_6) + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +**Description:** connector.yaml is how you configure a connector for your Firebase Data Connect service. + +
+ + 1. [Optional] Property root > connectorId + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** The ID of the Firebase Data Connect connector. + +
+
+ +
+ + 2. [Optional] Property root > generate + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 2.1. [Optional] Property root > generate > javascriptSdk + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** Configuration for a generated Javascript SDK + +
+ +| One of(Option) | +| ------------------------------------------------- | +| [javascriptSdk](#generate_javascriptSdk_oneOf_i0) | +| [item 1](#generate_javascriptSdk_oneOf_i1) | + +
+ +#### 2.1.1. Property `root > generate > javascriptSdk > oneOf > javascriptSdk` + +| | | +| ------------------------- | --------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/javascriptSdk | + +
+ + 2.1.1.1. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > outputDir + + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -# +**Description:** Path to the directory where generated files should be written to. +
+
+
+ + 2.1.1.2. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > package -
DescriptionThe deploy target to these Storage rules to. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.
TypeString
- - - - -
$idconnector.yaml
$schemahttp://json-schema.org/draft-07/schema#
+ +
-## Properties +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -
NameType
connectorIdString
generateObject
+**Description:** The package name to use for the generated code. +
+ +
+ + 2.1.1.3. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir -
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -## connectorId +**Description:** The directory containining the package.json to install the generated package in. +
+
- - - - - - - - - - - - - -
DescriptionThe ID of the Firebase Data Connect connector.
TypeString
RequiredNo
+ +
+#### 2.1.2. Property `root > generate > javascriptSdk > oneOf > item 1` +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -## generate +| Each item of this array must be | Description | +| ------------------------------------------------------- | ----------- | +| [javascriptSdk](#generate_javascriptSdk_oneOf_i1_items) | - | +##### 2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk - - - - - - - - - -
TypeObject
RequiredNo
+| | | +| ------------------------- | ------------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [generate_javascriptSdk_oneOf_i0](#generate_javascriptSdk_oneOf_i0) | -### Properties -
NameType
javascriptSdkOne of:Object
Array
dartSdkOne of:Object
Array
kotlinSdkOne of:Object
Array
swiftSdkOne of:Object
Array
llmToolsOne of:Object
Array
+
+ -### generate.javascriptSdk + + +
+ + 2.2. [Optional] Property root > generate > dartSdk - - - - - - - - - - - - - -
DescriptionConfiguration for a generated Javascript SDK
TypeOne of:Object
Array
RequiredNo
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** Configuration for a generated Dart SDK -### generate.javascriptSdk.0 +
+| One of(Option) | +| ------------------------------------- | +| [dartSdk](#generate_dartSdk_oneOf_i0) | +| [item 1](#generate_dartSdk_oneOf_i1) | - - - - - -
TypeObject
+
+#### 2.2.1. Property `root > generate > dartSdk > oneOf > dartSdk` +| | | +| ------------------------- | --------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/dartSdk | -### generate.javascriptSdk.0.outputDir +
+ + 2.2.1.1. [Optional] Property root > generate > dartSdk > oneOf > item 0 > outputDir + +
- - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Path to the directory where generated files should be written to. +
+
+
+ + 2.2.1.2. [Optional] Property root > generate > dartSdk > oneOf > item 0 > package -### generate.javascriptSdk.0.package + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionThe package name to use for the generated code.
TypeString
+**Description:** The package name to use for the generated code. +
+
+
+
+#### 2.2.2. Property `root > generate > dartSdk > oneOf > item 1` -### generate.javascriptSdk.0.packageJSONDir +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - - - - - -
DescriptionThe directory containining the package.json to install the generated package in.
TypeString
+| Each item of this array must be | Description | +| ------------------------------------------- | ----------- | +| [dartSdk](#generate_dartSdk_oneOf_i1_items) | - | +##### 2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk +| | | +| ------------------------- | ------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [generate_dartSdk_oneOf_i0](#generate_dartSdk_oneOf_i0) | +
+
-### generate.javascriptSdk.1 +
+
+
+ + 2.3. [Optional] Property root > generate > kotlinSdk - - - - - -
TypeArray
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** Configuration for a generated Kotlin SDK -### generate.javascriptSdk.1.outputDir +
+| One of(Option) | +| ----------------------------------------- | +| [kotlinSdk](#generate_kotlinSdk_oneOf_i0) | +| [item 1](#generate_kotlinSdk_oneOf_i1) | - - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
+
+#### 2.3.1. Property `root > generate > kotlinSdk > oneOf > kotlinSdk` +| | | +| ------------------------- | ----------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/kotlinSdk | +
+ + 2.3.1.1. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > outputDir -### generate.javascriptSdk.1.package + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionThe package name to use for the generated code.
TypeString
+**Description:** Path to the directory where generated files should be written to. +
+
+
+ + 2.3.1.2. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > package + +
-### generate.javascriptSdk.1.packageJSONDir +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The package name to use for the generated code. - - - - - - - - - -
DescriptionThe directory containining the package.json to install the generated package in.
TypeString
+
+
+
+
+#### 2.3.2. Property `root > generate > kotlinSdk > oneOf > item 1` +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ----------------------------------------------- | ----------- | +| [kotlinSdk](#generate_kotlinSdk_oneOf_i1_items) | - | -### generate.dartSdk +##### 2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk +| | | +| ------------------------- | ----------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [generate_kotlinSdk_oneOf_i0](#generate_kotlinSdk_oneOf_i0) | - - - - - - - - - - - - - -
DescriptionConfiguration for a generated Dart SDK
TypeOne of:Object
Array
RequiredNo
+
+
+
+
-### generate.dartSdk.0 +
+ + 2.4. [Optional] Property root > generate > swiftSdk + +
- - - - - -
TypeObject
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** Configuration for a generated Swift SDK +
-### generate.dartSdk.0.outputDir +| One of(Option) | +| --------------------------------------- | +| [swiftSdk](#generate_swiftSdk_oneOf_i0) | +| [item 1](#generate_swiftSdk_oneOf_i1) | +
- - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
+#### 2.4.1. Property `root > generate > swiftSdk > oneOf > swiftSdk` +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/swiftSdk | +
+ + 2.4.1.1. [Optional] Property root > generate > swiftSdk > oneOf > item 0 > outputDir + +
-### generate.dartSdk.0.package +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Path to the directory where generated files should be written to. - - - - - - - - - -
DescriptionThe package name to use for the generated code.
TypeString
+
+
+
+
+#### 2.4.2. Property `root > generate > swiftSdk > oneOf > item 1` +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### generate.dartSdk.1 +| Each item of this array must be | Description | +| --------------------------------------------- | ----------- | +| [swiftSdk](#generate_swiftSdk_oneOf_i1_items) | - | +##### 2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk - - - - - -
TypeArray
+| | | +| ------------------------- | --------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [generate_swiftSdk_oneOf_i0](#generate_swiftSdk_oneOf_i0) | +
+
-### generate.dartSdk.1.outputDir +
+
+
+ + 2.5. [Optional] Property root > generate > llmTools - - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +
+| One of(Option) | +| --------------------------------------- | +| [llmTools](#generate_llmTools_oneOf_i0) | +| [item 1](#generate_llmTools_oneOf_i1) | -### generate.dartSdk.1.package +
+#### 2.5.1. Property `root > generate > llmTools > oneOf > llmTools` - - - - - - - - - -
DescriptionThe package name to use for the generated code.
TypeString
+| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/llmTools | +
+ + 2.5.1.1. [Optional] Property root > generate > llmTools > oneOf > item 0 > outputFile + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Path where the JSON LLM tool definitions file should be generated. +
+
-### generate.kotlinSdk +
+
+#### 2.5.2. Property `root > generate > llmTools > oneOf > item 1` - - - - - - - - - - - - - -
DescriptionConfiguration for a generated Kotlin SDK
TypeOne of:Object
Array
RequiredNo
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| --------------------------------------------- | ----------- | +| [llmTools](#generate_llmTools_oneOf_i1_items) | - | -### generate.kotlinSdk.0 +##### 2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools +| | | +| ------------------------- | --------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [generate_llmTools_oneOf_i0](#generate_llmTools_oneOf_i0) | - - - - - -
TypeObject
+
+
+
+
-### generate.kotlinSdk.0.outputDir - - - - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
- - - - -### generate.kotlinSdk.0.package - - - - - - - - - - - -
DescriptionThe package name to use for the generated code.
TypeString
- - - - - -### generate.kotlinSdk.1 - - - - - - - -
TypeArray
- - - -### generate.kotlinSdk.1.outputDir - - - - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
- - - - -### generate.kotlinSdk.1.package - - - - - - - - - - - -
DescriptionThe package name to use for the generated code.
TypeString
- - - - - - -### generate.swiftSdk - - - - - - - - - - - - - - - -
DescriptionConfiguration for a generated Swift SDK
TypeOne of:Object
Array
RequiredNo
- - - -### generate.swiftSdk.0 - - - - - - - -
TypeObject
- - - -### generate.swiftSdk.0.outputDir - - - - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
- - - - - -### generate.swiftSdk.1 - - - - - - - -
TypeArray
- - - -### generate.swiftSdk.1.outputDir - - - - - - - - - - - -
DescriptionPath to the directory where generated files should be written to.
TypeString
- - - - - - -### generate.llmTools - - - - - - - - - - - -
TypeOne of:Object
Array
RequiredNo
- - - -### generate.llmTools.0 - - - - - - - -
TypeObject
- - - -### generate.llmTools.0.outputFile - - - - - - - - - - - -
DescriptionPath where the JSON LLM tool definitions file should be generated.
TypeString
- - - - - -### generate.llmTools.1 - - - - - - - -
TypeArray
- - - -### generate.llmTools.1.outputFile - - - - - - - - - - - -
DescriptionPath where the JSON LLM tool definitions file should be generated.
TypeString
- - - - - - - - - - - - -
- -## Schema -``` -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "connector.yaml", - "additionalProperties": false, - "definitions": { - "javascriptSdk": { - "additionalProperties": true, - "type": "object", - "properties": { - "outputDir": { - "type": "string", - "description": "Path to the directory where generated files should be written to." - }, - "package": { - "type": "string", - "description": "The package name to use for the generated code." - }, - "packageJSONDir": { - "type": "string", - "description": "The directory containining the package.json to install the generated package in." - } - } - }, - "dartSdk": { - "additionalProperties": true, - "type": "object", - "properties": { - "outputDir": { - "type": "string", - "description": "Path to the directory where generated files should be written to." - }, - "package": { - "type": "string", - "description": "The package name to use for the generated code." - } - } - }, - "kotlinSdk": { - "additionalProperties": true, - "type": "object", - "properties": { - "outputDir": { - "type": "string", - "description": "Path to the directory where generated files should be written to." - }, - "package": { - "type": "string", - "description": "The package name to use for the generated code." - } - } - }, - "swiftSdk": { - "additionalProperties": true, - "type": "object", - "properties": { - "outputDir": { - "type": "string", - "description": "Path to the directory where generated files should be written to." - } - } - }, - "llmTools": { - "additionalProperties": true, - "type": "object", - "properties": { - "outputFile": { - "type": "string", - "description": "Path where the JSON LLM tool definitions file should be generated." - } - } - } - }, - "properties": { - "connectorId": { - "type": "string", - "description": "The ID of the Firebase Data Connect connector." - }, - "generate": { - "type": "object", - "additionalProperties": false, - "properties": { - "javascriptSdk": { - "oneOf": [ - { - "$ref": "#/definitions/javascriptSdk" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/javascriptSdk" - } - } - ], - "description": "Configuration for a generated Javascript SDK" - }, - "dartSdk": { - "oneOf": [ - { - "$ref": "#/definitions/dartSdk" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/dartSdk" - } - } - ], - "description": "Configuration for a generated Dart SDK" - }, - "kotlinSdk": { - "oneOf": [ - { - "$ref": "#/definitions/kotlinSdk" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/kotlinSdk" - } - } - ], - "description": "Configuration for a generated Kotlin SDK" - }, - "swiftSdk": { - "oneOf": [ - { - "$ref": "#/definitions/swiftSdk" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/swiftSdk" - } - } - ], - "description": "Configuration for a generated Swift SDK" - }, - "llmTools": { - "oneOf": [ - { - "$ref": "#/definitions/llmTools" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/llmTools" - } - } - ] - } - } - } - } -} -``` - + + +---------------------------------------------------------------------------------------------------------------------------- +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file diff --git a/schema/docs/dataconnect-yaml.md b/schema/docs/dataconnect-yaml.md index 5cd3899bb2a..c2f73477eb4 100644 --- a/schema/docs/dataconnect-yaml.md +++ b/schema/docs/dataconnect-yaml.md @@ -1,353 +1,252 @@ +# Schema Docs +- [1. [Optional] Property root > specVersion](#specVersion) +- [2. [Optional] Property root > serviceId](#serviceId) +- [3. [Optional] Property root > location](#location) +- [4. [Optional] Property root > connectorDirs](#connectorDirs) + - [4.1. root > connectorDirs > connectorDirs items](#autogenerated_heading_2) +- [5. [Optional] Property root > schema](#schema) + - [5.1. [Optional] Property root > schema > source](#schema_source) + - [5.2. [Optional] Property root > schema > datasource](#schema_datasource) + - [5.2.1. [Optional] Property root > schema > datasource > postgresql](#schema_datasource_postgresql) + - [5.2.1.1. [Optional] Property root > schema > datasource > postgresql > database](#schema_datasource_postgresql_database) + - [5.2.1.2. [Optional] Property root > schema > datasource > postgresql > cloudSql](#schema_datasource_postgresql_cloudSql) + - [5.2.1.2.1. [Optional] Property root > schema > datasource > postgresql > cloudSql > instanceId](#schema_datasource_postgresql_cloudSql_instanceId) + - [5.2.1.2.2. [Optional] Property root > schema > datasource > postgresql > cloudSql > schemaValidation](#schema_datasource_postgresql_cloudSql_schemaValidation) -# +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** dataconnect.yaml is how you configure a Firebase Data Connect service. + +
+ + 1. [Optional] Property root > specVersion + + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** The Firebase Data Connect API version to target. If omitted, defaults to the latest version - - - - - -
$iddataconnect.yaml
$schemahttp://json-schema.org/draft-07/schema#
+
+
-## Properties +
+ + 2. [Optional] Property root > serviceId -
NameType
specVersionString
serviceIdString
locationString
connectorDirsArray
schemaObject
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The ID of the Firebase Data Connect service. -
+
+
+
+ + 3. [Optional] Property root > location -## specVersion + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionThe Firebase Data Connect API version to target. If omitted, defaults to the latest version
TypeString
RequiredNo
+**Description:** The region of the Firebase Data Connect service. + +
+
+
+ + 4. [Optional] Property root > connectorDirs + +
+| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -## serviceId +**Description:** A list of directories containing conector.yaml files describing a connector to deploy. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - - - - - - - - - -
DescriptionThe ID of the Firebase Data Connect service.
TypeString
RequiredNo
+| Each item of this array must be | Description | +| ------------------------------------------- | ----------- | +| [connectorDirs items](#connectorDirs_items) | - | +### 4.1. root > connectorDirs > connectorDirs items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+
+ + 5. [Optional] Property root > schema -## location + +
+| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/schema | - - - - - - - - - - - - - -
DescriptionThe region of the Firebase Data Connect service.
TypeString
RequiredNo
+
+ + 5.1. [Optional] Property root > schema > source + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema. -## connectorDirs +
+
+
+ + 5.2. [Optional] Property root > schema > datasource - - - - - - - - - - - - - -
DescriptionA list of directories containing conector.yaml files describing a connector to deploy.
TypeArray
RequiredNo
+ +
+| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/dataSource | +
+ + 5.2.1. [Optional] Property root > schema > datasource > postgresql + +
-## schema +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/postgresql | +
+ + 5.2.1.1. [Optional] Property root > schema > datasource > postgresql > database - - - - - - - - - -
TypeObject
RequiredNo
+ +
-### Properties -
NameType
sourceString
datasourceOne of:Object
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The name of the PostgreSQL database. -### schema.source +
+
+
+ + 5.2.1.2. [Optional] Property root > schema > datasource > postgresql > cloudSql - - - - - - - - - - - - - -
DescriptionRelative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema.
TypeString
RequiredNo
+ +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 5.2.1.2.1. [Optional] Property root > schema > datasource > postgresql > cloudSql > instanceId + +
-### schema.datasource +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The ID of the CloudSQL instance for this database - - - - - - - - - -
TypeOne of:Object
RequiredNo
+
+
+
+ + 5.2.1.2.2. [Optional] Property root > schema > datasource > postgresql > cloudSql > schemaValidation + +
-### schema.datasource.0 +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | +**Description:** Schema validation mode for schema migrations - - - - - -
TypeObject
+Must be one of: +* "COMPATIBLE" +* "STRICT" +
+
+
+
-### schema.datasource.0.postgresql +
+
+
+
- - - - - -
TypeObject
- - - -### schema.datasource.0.postgresql.database - - - - - - - - - - - -
DescriptionThe name of the PostgreSQL database.
TypeString
- - - - -### schema.datasource.0.postgresql.cloudSql - - - - - - - -
TypeObject
- - - -### schema.datasource.0.postgresql.cloudSql.instanceId - - - - - - - - - - - -
DescriptionThe ID of the CloudSQL instance for this database
TypeString
- - - - -### schema.datasource.0.postgresql.cloudSql.schemaValidation - - - - - - - - - - - - - - -
DescriptionSchema validation mode for schema migrations
TypeString
Enum
  • COMPATIBLE
  • STRICT
- - - - - - - - - - - - - - -
- -## Schema -``` -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "dataconnect.yaml", - "additionalProperties": false, - "definitions": { - "postgresql": { - "additionalProperties": false, - "type": "object", - "properties": { - "database": { - "type": "string", - "description": "The name of the PostgreSQL database." - }, - "cloudSql": { - "additionalProperties": false, - "type": "object", - "properties": { - "instanceId": { - "type": "string", - "description": "The ID of the CloudSQL instance for this database" - }, - "schemaValidation": { - "type": "string", - "enum": [ - "COMPATIBLE", - "STRICT" - ], - "description": "Schema validation mode for schema migrations" - } - } - } - } - }, - "dataSource": { - "oneOf": [ - { - "additionalProperties": false, - "type": "object", - "properties": { - "postgresql": { - "$ref": "#/definitions/postgresql" - } - } - } - ] - }, - "schema": { - "additionalProperties": false, - "type": "object", - "properties": { - "source": { - "type": "string", - "description": "Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema." - }, - "datasource": { - "$ref": "#/definitions/dataSource" - } - } - } - }, - "properties": { - "specVersion": { - "type": "string", - "description": "The Firebase Data Connect API version to target. If omitted, defaults to the latest version" - }, - "serviceId": { - "type": "string", - "description": "The ID of the Firebase Data Connect service." - }, - "location": { - "type": "string", - "description": "The region of the Firebase Data Connect service." - }, - "connectorDirs": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of directories containing conector.yaml files describing a connector to deploy." - }, - "schema": { - "$ref": "#/definitions/schema" - } - } -} -``` - +
+
+---------------------------------------------------------------------------------------------------------------------------- +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file diff --git a/schema/docs/extension-yaml.md b/schema/docs/extension-yaml.md index 818724f53ca..a98311e3445 100644 --- a/schema/docs/extension-yaml.md +++ b/schema/docs/extension-yaml.md @@ -1,2011 +1,1734 @@ +# Schema Docs + +- [1. [Optional] Property root > name](#name) +- [2. [Optional] Property root > version](#version) +- [3. [Optional] Property root > specVersion](#specVersion) +- [4. [Optional] Property root > license](#license) +- [5. [Optional] Property root > displayName](#displayName) +- [6. [Optional] Property root > description](#description) +- [7. [Optional] Property root > icon](#icon) +- [8. [Optional] Property root > billingRequired](#billingRequired) +- [9. [Optional] Property root > tags](#tags) + - [9.1. root > tags > tags items](#autogenerated_heading_2) +- [10. [Optional] Property root > sourceUrl](#sourceUrl) +- [11. [Optional] Property root > releaseNotesUrl](#releaseNotesUrl) +- [12. [Optional] Property root > author](#author) + - [12.1. [Optional] Property root > author > authorName](#author_authorName) + - [12.2. [Optional] Property root > author > email](#author_email) + - [12.3. [Optional] Property root > author > url](#author_url) +- [13. [Optional] Property root > contributors](#contributors) + - [13.1. root > contributors > author](#autogenerated_heading_3) +- [14. [Optional] Property root > apis](#apis) + - [14.1. root > apis > api](#autogenerated_heading_4) + - [14.1.1. [Required] Property root > apis > apis items > apiName](#apis_items_apiName) + - [14.1.2. [Required] Property root > apis > apis items > reason](#apis_items_reason) +- [15. [Optional] Property root > roles](#roles) + - [15.1. root > roles > role](#autogenerated_heading_5) + - [15.1.1. [Required] Property root > roles > roles items > role](#roles_items_role) + - [15.1.2. [Required] Property root > roles > roles items > reason](#roles_items_reason) + - [15.1.3. [Optional] Property root > roles > roles items > resource](#roles_items_resource) +- [16. [Optional] Property root > externalServices](#externalServices) + - [16.1. root > externalServices > externalService](#autogenerated_heading_6) + - [16.1.1. [Optional] Property root > externalServices > externalServices items > name](#externalServices_items_name) + - [16.1.2. [Optional] Property root > externalServices > externalServices items > pricingUri](#externalServices_items_pricingUri) +- [17. [Optional] Property root > params](#params) + - [17.1. root > params > param](#autogenerated_heading_7) + - [17.1.1. [Required] Property root > params > params items > param](#params_items_param) + - [17.1.2. [Optional] Property root > params > params items > label](#params_items_label) + - [17.1.3. [Optional] Property root > params > params items > description](#params_items_description) + - [17.1.4. [Optional] Property root > params > params items > example](#params_items_example) + - [17.1.5. [Optional] Property root > params > params items > validationRegex](#params_items_validationRegex) + - [17.1.6. [Optional] Property root > params > params items > validationErrorMessage](#params_items_validationErrorMessage) + - [17.1.7. [Optional] Property root > params > params items > default](#params_items_default) + - [17.1.8. [Optional] Property root > params > params items > required](#params_items_required) + - [17.1.9. [Optional] Property root > params > params items > immutable](#params_items_immutable) + - [17.1.10. [Optional] Property root > params > params items > advanced](#params_items_advanced) + - [17.1.11. [Optional] Property root > params > params items > type](#params_items_type) + - [17.1.12. [Optional] Property root > params > params items > resourceType](#params_items_resourceType) + - [17.1.13. [Optional] Property root > params > params items > options](#params_items_options) + - [17.1.13.1. root > params > params items > options > paramOption](#autogenerated_heading_8) + - [17.1.13.1.1. [Required] Property root > params > params items > options > options items > value](#params_items_options_items_value) + - [17.1.13.1.2. [Optional] Property root > params > params items > options > options items > label](#params_items_options_items_label) +- [18. [Optional] Property root > resources](#resources) + - [18.1. root > resources > resource](#autogenerated_heading_9) + - [18.1.1. [Required] Property root > resources > resources items > name](#resources_items_name) + - [18.1.2. [Required] Property root > resources > resources items > type](#resources_items_type) + - [18.1.3. [Required] Property root > resources > resources items > description](#resources_items_description) + - [18.1.4. [Required] Property root > resources > resources items > properties](#resources_items_properties) + - [18.1.4.1. [Optional] Property root > resources > resources items > properties > location](#resources_items_properties_location) + - [18.1.4.2. [Optional] Property root > resources > resources items > properties > entryPoint](#resources_items_properties_entryPoint) + - [18.1.4.3. [Optional] Property root > resources > resources items > properties > sourceDirectory](#resources_items_properties_sourceDirectory) + - [18.1.4.4. [Optional] Property root > resources > resources items > properties > timeout](#resources_items_properties_timeout) + - [18.1.4.5. [Optional] Property root > resources > resources items > properties > availableMemoryMb](#resources_items_properties_availableMemoryMb) + - [18.1.4.6. [Optional] Property root > resources > resources items > properties > runtime](#resources_items_properties_runtime) + - [18.1.4.7. [Optional] Property root > resources > resources items > properties > httpsTrigger](#resources_items_properties_httpsTrigger) + - [18.1.4.8. [Optional] Property root > resources > resources items > properties > eventTrigger](#resources_items_properties_eventTrigger) + - [18.1.4.8.1. [Required] Property root > resources > resources items > properties > eventTrigger > eventType](#resources_items_properties_eventTrigger_eventType) + - [18.1.4.8.2. [Optional] Property root > resources > resources items > properties > eventTrigger > resource](#resources_items_properties_eventTrigger_resource) + - [18.1.4.8.3. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters](#resources_items_properties_eventTrigger_eventFilters) + - [18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter](#autogenerated_heading_10) + - [18.1.4.8.3.1.1. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute](#resources_items_properties_eventTrigger_eventFilters_items_attribute) + - [18.1.4.8.3.1.2. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value](#resources_items_properties_eventTrigger_eventFilters_items_value) + - [18.1.4.8.4. [Optional] Property root > resources > resources items > properties > eventTrigger > channel](#resources_items_properties_eventTrigger_channel) + - [18.1.4.8.5. [Optional] Property root > resources > resources items > properties > eventTrigger > triggerRegion](#resources_items_properties_eventTrigger_triggerRegion) + - [18.1.4.9. [Optional] Property root > resources > resources items > properties > scheduleTrigger](#resources_items_properties_scheduleTrigger) + - [18.1.4.9.1. [Required] Property root > resources > resources items > properties > scheduleTrigger > schedule](#resources_items_properties_scheduleTrigger_schedule) + - [18.1.4.9.2. [Optional] Property root > resources > resources items > properties > scheduleTrigger > timeZone](#resources_items_properties_scheduleTrigger_timeZone) + - [18.1.4.10. [Optional] Property root > resources > resources items > properties > taskQueueTrigger](#resources_items_properties_taskQueueTrigger) + - [18.1.4.11. [Optional] Property root > resources > resources items > properties > buildConfig](#resources_items_properties_buildConfig) + - [18.1.4.11.1. [Optional] Property root > resources > resources items > properties > buildConfig > runtime](#resources_items_properties_buildConfig_runtime) + - [18.1.4.11.2. [Optional] Property root > resources > resources items > properties > buildConfig > entryPoint](#resources_items_properties_buildConfig_entryPoint) + - [18.1.4.12. [Optional] Property root > resources > resources items > properties > serviceConfig](#resources_items_properties_serviceConfig) + - [18.1.4.12.1. [Optional] Property root > resources > resources items > properties > serviceConfig > timeoutSeconds](#resources_items_properties_serviceConfig_timeoutSeconds) + - [18.1.4.12.2. [Optional] Property root > resources > resources items > properties > serviceConfig > availableMemory](#resources_items_properties_serviceConfig_availableMemory) +- [19. [Optional] Property root > lifecycleEvents](#lifecycleEvents) + - [19.1. root > lifecycleEvents > lifecycleEvent](#autogenerated_heading_11) + - [19.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall](#lifecycleEvents_items_onInstall) + - [19.1.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > function](#lifecycleEvents_items_onInstall_function) + - [19.1.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage](#lifecycleEvents_items_onInstall_processingMessage) + - [19.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onUpdate](#lifecycleEvents_items_onUpdate) + - [19.1.3. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onConfigure](#lifecycleEvents_items_onConfigure) +- [20. [Optional] Property root > events](#events) + - [20.1. root > events > event](#autogenerated_heading_12) + - [20.1.1. [Optional] Property root > events > events items > type](#events_items_type) + - [20.1.2. [Optional] Property root > events > events items > description](#events_items_description) + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +**Description:** extension.yaml declares the resources and configurable parameters for a Firebase Extension. + +
+ + 1. [Optional] Property root > name + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** ID of this extension (ie your-extension-name) + +
+
+ +
+ + 2. [Optional] Property root > version + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** Version of this extension. Follows https://semver.org/. + +
+
+ +
+ + 3. [Optional] Property root > specVersion + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** Version of the extension.yaml spec that this file follows. Currently always 'v1beta' + +
+
+ +
+ + 4. [Optional] Property root > license + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev +
+
-# +
+ + 5. [Optional] Property root > displayName + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
$idextension.yaml
$schemahttp://json-schema.org/draft-07/schema#
+**Description:** Human readable name for this extension (ie 'Your Extension Name') -## Properties +
+
-
NameType
nameString
versionString
specVersionString
licenseString
displayNameString
descriptionString
iconString
billingRequiredBoolean
tagsArray
sourceUrlString
releaseNotesUrlString
authorObject
contributorsArray
apisArray
rolesArray
externalServicesArray
paramsArray
resourcesArray
lifecycleEventsArray
eventsArray
+
+ + 6. [Optional] Property root > description + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -
+**Description:** A one to two sentence description of what this extension does +
+
-## name +
+ + 7. [Optional] Property root > icon + +
- - - - - - - - - - - - - -
DescriptionID of this extension (ie your-extension-name)
TypeString
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The file name of this extension's icon +
+
+
+ + 8. [Optional] Property root > billingRequired -## version + +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionVersion of this extension. Follows https://semver.org/.
TypeString
RequiredNo
+**Description:** Whether this extension requires a billing to be enabled on the project it is installed on +
+
+
+ + 9. [Optional] Property root > tags + +
-## specVersion +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +**Description:** A list of tags to help users find your extension in search - - - - - - - - - - - - - -
DescriptionVersion of the extension.yaml spec that this file follows. Currently always 'v1beta'
TypeString
RequiredNo
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------- | ----------- | +| [tags items](#tags_items) | - | +### 9.1. root > tags > tags items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -## license +
+
+
+ + 10. [Optional] Property root > sourceUrl - - - - - - - - - - - - - -
DescriptionThe software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev
TypeString
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The URL of the GitHub repo hosting this code +
+
-## displayName +
+ + 11. [Optional] Property root > releaseNotesUrl + +
- - - - - - - - - - - - - -
DescriptionHuman readable name for this extension (ie 'Your Extension Name')
TypeString
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** A URL where users can view the full changelog or release notes for this extension +
+
+
+ + 12. [Optional] Property root > author -## description + +
+| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/author | - - - - - - - - - - - - - -
DescriptionA one to two sentence description of what this extension does
TypeString
RequiredNo
+
+ + 12.1. [Optional] Property root > author > authorName + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The author's name -## icon +
+
+
+ + 12.2. [Optional] Property root > author > email - - - - - - - - - - - - - -
DescriptionThe file name of this extension's icon
TypeString
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** A contact email for the author +
+
-## billingRequired +
+ + 12.3. [Optional] Property root > author > url + +
- - - - - - - - - - - - - -
DescriptionWhether this extension requires a billing to be enabled on the project it is installed on
TypeBoolean
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** URL of the author's website +
+
+
+
-## tags +
+ + 13. [Optional] Property root > contributors + +
- - - - - - - - - - - - - -
DescriptionA list of tags to help users find your extension in search
TypeArray
RequiredNo
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------- | ----------- | +| [author](#contributors_items) | - | +### 13.1. root > contributors > author -## sourceUrl +| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [author](#author) | +
+
- - - - - - - - - - - - - -
DescriptionThe URL of the GitHub repo hosting this code
TypeString
RequiredNo
+
+ + 14. [Optional] Property root > apis + +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -## releaseNotesUrl +| Each item of this array must be | Description | +| ------------------------------- | ----------------------------------------------------------------------------- | +| [api](#apis_items) | A Google API used by this extension. Will be enabled on extension deployment. | +### 14.1. root > apis > api - - - - - - - - - - - - - -
DescriptionA URL where users can view the full changelog or release notes for this extension
TypeString
RequiredNo
+| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/api | +**Description:** A Google API used by this extension. Will be enabled on extension deployment. +
+ + 14.1.1. [Required] Property root > apis > apis items > apiName + +
-## author +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** Name of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library - - - - - - - - - -
TypeObject
RequiredNo
+| Restrictions | | +| --------------------------------- | ------------------------------------------------------------------------------------------------------- | +| **Must match regular expression** | ```[^\.]+\.googleapis\.com``` [Test](https://regex101.com/?regex=%5B%5E%5C.%5D%2B%5C.googleapis%5C.com) | -### Properties -
NameType
authorNameString
emailString
urlString
+
+
+
+ + 14.1.2. [Required] Property root > apis > apis items > reason -### author.authorName + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - - - - - - - - - -
DescriptionThe author's name
TypeString
RequiredNo
+**Description:** Why this extension needs this API enabled +
+
+
+
+
+ + 15. [Optional] Property root > roles -### author.email + +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionA contact email for the author
TypeString
RequiredNo
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------- | --------------------------------------- | +| [role](#roles_items) | An IAM role to grant to this extension. | +### 15.1. root > roles > role +| | | +| ------------------------- | ------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/role | -### author.url +**Description:** An IAM role to grant to this extension. +
+ + 15.1.1. [Required] Property root > roles > roles items > role - - - - - - - - - - - - - -
DescriptionURL of the author's website
TypeString
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** Name of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles +| Restrictions | | +| --------------------------------- | ------------------------------------------------------------------------------------------------- | +| **Must match regular expression** | ```[a-zA-Z]+\.[a-zA-Z]+``` [Test](https://regex101.com/?regex=%5Ba-zA-Z%5D%2B%5C.%5Ba-zA-Z%5D%2B) | +
+
-## contributors +
+ + 15.1.2. [Required] Property root > roles > roles items > reason + +
- - - - - - - - - -
TypeArray
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** Why this extension needs this IAM role +
+
+
+ + 15.1.3. [Optional] Property root > roles > roles items > resource -## apis + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
TypeArray
RequiredNo
+**Description:** What resource to grant this role on. If omitted, defaults to projects/${project_id} +
+
+
+
-### apis.apiName +
+ + 16. [Optional] Property root > externalServices + +
- - - - - - - - - - - - -
DescriptionName of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library
TypeString
Pattern[^\.]+\.googleapis\.com
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------ | --------------------------------------- | +| [externalService](#externalServices_items) | A non-Google API used by this extension | +### 16.1. root > externalServices > externalService -### apis.reason +| | | +| ------------------------- | ----------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/externalService | +**Description:** A non-Google API used by this extension - - - - - - - - - -
DescriptionWhy this extension needs this API enabled
TypeString
+
+ + 16.1.1. [Optional] Property root > externalServices > externalServices items > name + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Name of the external service +
+
-## roles +
+ + 16.1.2. [Optional] Property root > externalServices > externalServices items > pricingUri + +
- - - - - - - - - -
TypeArray
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** URI to pricing information for the service +
+
-### roles.role +
+
+
+ + 17. [Optional] Property root > params - - - - - - - - - - - - -
DescriptionName of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles
TypeString
Pattern[a-zA-Z]+\.[a-zA-Z]+
+ +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------- | -------------------------------------------------------------- | +| [param](#params_items) | A parameter that users installing this extension can configure | -### roles.reason +### 17.1. root > params > param +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/param | - - - - - - - - - -
DescriptionWhy this extension needs this IAM role
TypeString
+**Description:** A parameter that users installing this extension can configure +
+ + 17.1.1. [Required] Property root > params > params items > param + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | -### roles.resource +**Description:** The name of the param. This is how you reference the param in your code +
+
- - - - - - - - - -
DescriptionWhat resource to grant this role on. If omitted, defaults to projects/${project_id}
TypeString
+
+ + 17.1.2. [Optional] Property root > params > params items > label + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Short description for the parameter. Displayed to users when they're prompted for the parameter's value. +
+
-## externalServices +
+ + 17.1.3. [Optional] Property root > params > params items > description + +
- - - - - - - - - -
TypeArray
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value. +
+
-### externalServices.name +
+ + 17.1.4. [Optional] Property root > params > params items > example + +
- - - - - - - - - -
DescriptionName of the external service
TypeString
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Example value for the parameter. +
+
+
+ + 17.1.5. [Optional] Property root > params > params items > validationRegex -### externalServices.pricingUri + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionURI to pricing information for the service
TypeString
+**Description:** Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax. +
+
+
+ + 17.1.6. [Optional] Property root > params > params items > validationErrorMessage + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -## params +**Description:** Error message to display if regex validation fails. +
+
- - - - - - - - - -
TypeArray
RequiredNo
+
+ + 17.1.7. [Optional] Property root > params > params items > default + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### params.param +**Description:** Default value for the parameter if the user leaves the parameter's value blank. +
+
- - - - - - - - - -
DescriptionThe name of the param. This is how you reference the param in your code
TypeString
+
+ + 17.1.8. [Optional] Property root > params > params items > required + +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | +**Description:** Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true. -### params.label +
+
+
+ + 17.1.9. [Optional] Property root > params > params items > immutable - - - - - - - - - -
DescriptionShort description for the parameter. Displayed to users when they're prompted for the parameter's value.
TypeString
+ +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | +**Description:** Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false. +
+
-### params.description +
+ + 17.1.10. [Optional] Property root > params > params items > advanced + +
- - - - - - - - - -
DescriptionDetailed description for the parameter. Displayed to users when they're prompted for the parameter's value.
TypeString
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | +**Description:** Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param. +
+
+
+ + 17.1.11. [Optional] Property root > params > params items > type -### params.example + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionExample value for the parameter.
TypeString
+**Description:** The parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details. +| Restrictions | | +| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Must match regular expression** | ```string\|select\|multiSelect\|secret\|selectResource``` [Test](https://regex101.com/?regex=string%7Cselect%7CmultiSelect%7Csecret%7CselectResource) | +
+
+
+ + 17.1.12. [Optional] Property root > params > params items > resourceType -### params.validationRegex + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionRegular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax.
TypeString
+**Description:** The type of resource to prompt the user to select. Provides a special UI treatment for the param. +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Must match regular expression** | ```storage\.googleapis\.com\/Bucket\|firestore\.googleapis\.com\/Database\|firebasedatabase\.googleapis\.com\/DatabaseInstance``` [Test](https://regex101.com/?regex=storage%5C.googleapis%5C.com%5C%2FBucket%7Cfirestore%5C.googleapis%5C.com%5C%2FDatabase%7Cfirebasedatabase%5C.googleapis%5C.com%5C%2FDatabaseInstance) | +
+
+
+ + 17.1.13. [Optional] Property root > params > params items > options -### params.validationErrorMessage + +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | - - - - - - - - - -
DescriptionError message to display if regex validation fails.
TypeString
+**Description:** Options for a select or multiSelect type param. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------ | ----------- | +| [paramOption](#params_items_options_items) | - | +##### 17.1.13.1. root > params > params items > options > paramOption -### params.default +| | | +| ------------------------- | ------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/paramOption | +
+ + 17.1.13.1.1. [Required] Property root > params > params items > options > options items > value - - - - - - - - - -
DescriptionDefault value for the parameter if the user leaves the parameter's value blank.
TypeString
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** One of the values the user can choose. This is the value you get when you read the parameter value in code. +
+
-### params.required +
+ + 17.1.13.1.2. [Optional] Property root > params > params items > options > options items > label + +
- - - - - - - - - -
DescriptionDefines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true.
TypeBoolean
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Short description of the selectable option. If omitted, defaults to value. +
+
+
+
-### params.immutable +
+
+
+ + 18. [Optional] Property root > resources - - - - - - - - - -
DescriptionDefines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false.
TypeBoolean
+ +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------- | ----------- | +| [resource](#resources_items) | - | -### params.advanced +### 18.1. root > resources > resource +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/resource | - - - - - - - - - -
DescriptionWhether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param.
TypeBoolean
+
+ + 18.1.1. [Required] Property root > resources > resources items > name + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The name of this resource -### params.type +
+
+
+ + 18.1.2. [Required] Property root > resources > resources items > type - - - - - - - - - - - - -
DescriptionThe parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details.
TypeString
Patternstring|select|multiSelect|secret|selectResource
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options. +
+
-### params.resourceType +
+ + 18.1.3. [Required] Property root > resources > resources items > description + +
- - - - - - - - - - - - -
DescriptionThe type of resource to prompt the user to select. Provides a special UI treatment for the param.
TypeString
Patternstorage\.googleapis\.com\/Bucket|firestore\.googleapis\.com\/Database|firebasedatabase\.googleapis\.com\/DatabaseInstance
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** A brief description of what this resource does +
+
+
+ + 18.1.4. [Required] Property root > resources > resources items > properties -### params.options + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | - - - - - - - - - -
DescriptionOptions for a select or multiSelect type param.
TypeArray
+**Description:** The properties of this resource +
+ + 18.1.4.1. [Optional] Property root > resources > resources items > properties > location + +
-### params.options.value +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The location for this resource - - - - - - - - - -
DescriptionOne of the values the user can choose. This is the value you get when you read the parameter value in code.
TypeString
+
+
+
+ + 18.1.4.2. [Optional] Property root > resources > resources items > properties > entryPoint + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### params.options.label +**Description:** The entry point for a function resource +
+
- - - - - - - - - -
DescriptionShort description of the selectable option. If omitted, defaults to value.
TypeString
+
+ + 18.1.4.3. [Optional] Property root > resources > resources items > properties > sourceDirectory + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions +
+
+
+ + 18.1.4.4. [Optional] Property root > resources > resources items > properties > timeout -## resources + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
TypeArray
RequiredNo
+**Description:** A function resources's maximum execution time. +| Restrictions | | +| --------------------------------- | ------------------------------------------------------- | +| **Must match regular expression** | ```\d+s``` [Test](https://regex101.com/?regex=%5Cd%2Bs) | +
+
-### resources.name +
+ + 18.1.4.5. [Optional] Property root > resources > resources items > properties > availableMemoryMb + +
- - - - - - - - - -
DescriptionThe name of this resource
TypeString
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Amount of memory in MB available for the function. +| Restrictions | | +| --------------------------------- | ----------------------------------------------------- | +| **Must match regular expression** | ```\d+``` [Test](https://regex101.com/?regex=%5Cd%2B) | +
+
-### resources.type +
+ + 18.1.4.6. [Optional] Property root > resources > resources items > properties > runtime + +
- - - - - - - - - -
DescriptionWhat type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options.
TypeString
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. +
+
+
+ + 18.1.4.7. [Optional] Property root > resources > resources items > properties > httpsTrigger -### resources.description + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | - - - - - - - - - -
DescriptionA brief description of what this resource does
TypeString
+**Description:** A function triggered by HTTPS calls +
+
+
+ + 18.1.4.8. [Optional] Property root > resources > resources items > properties > eventTrigger + +
-### resources.properties +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A function triggered by a background event - - - - - - - - - -
DescriptionThe properties of this resource
TypeObject
+
+ + 18.1.4.8.1. [Required] Property root > resources > resources items > properties > eventTrigger > eventType + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | -### resources.properties.location +**Description:** The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list. +
+
- - - - - - - - - -
DescriptionThe location for this resource
TypeString
+
+ + 18.1.4.8.2. [Optional] Property root > resources > resources items > properties > eventTrigger > resource + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The name or pattern of the resource to trigger on -### resources.properties.entryPoint +
+
+
+ + 18.1.4.8.3. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters - - - - - - - - - -
DescriptionThe entry point for a function resource
TypeString
+ +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +**Description:** Filters that further limit the events to listen to. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### resources.properties.sourceDirectory +| Each item of this array must be | Description | +| -------------------------------------------------------------------------- | ----------- | +| [eventFilter](#resources_items_properties_eventTrigger_eventFilters_items) | - | +###### 18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter - - - - - - - - - -
DescriptionDirectory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions
TypeString
+| | | +| ------------------------- | ------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/eventFilter | +
+ + 18.1.4.8.3.1.1. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### resources.properties.timeout +**Description:** The event attribute to filter on +
+
- - - - - - - - - - - - -
DescriptionA function resources's maximum execution time.
TypeString
Pattern\d+s
+
+ + 18.1.4.8.3.1.2. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The value to filter for -### resources.properties.availableMemoryMb +
+
+
+
- - - - - - - - - - - - -
DescriptionAmount of memory in MB available for the function.
TypeString
Pattern\d+
+
+ + 18.1.4.8.4. [Optional] Property root > resources > resources items > properties > eventTrigger > channel + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel. -### resources.properties.runtime +
+
+
+ + 18.1.4.8.5. [Optional] Property root > resources > resources items > properties > eventTrigger > triggerRegion - - - - - - - - - -
DescriptionRuntime environment for the function. Defaults to the most recent LTS version of node.
TypeString
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function. +
+
-### resources.properties.httpsTrigger +
+
+
+ + 18.1.4.9. [Optional] Property root > resources > resources items > properties > scheduleTrigger - - - - - - - - - -
DescriptionA function triggered by HTTPS calls
TypeObject
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A function triggered at a regular interval by a Cloud Scheduler job +
+ + 18.1.4.9.1. [Required] Property root > resources > resources items > properties > scheduleTrigger > schedule -### resources.properties.eventTrigger + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - - - - - -
DescriptionA function triggered by a background event
TypeObject
+**Description:** The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax. +
+
+
+ + 18.1.4.9.2. [Optional] Property root > resources > resources items > properties > scheduleTrigger > timeZone -### resources.properties.eventTrigger.eventType + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionThe type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list.
TypeString
+**Description:** The time zone in which the schedule will run. Defaults to UTC. +
+
+
+
+
+ + 18.1.4.10. [Optional] Property root > resources > resources items > properties > taskQueueTrigger -### resources.properties.eventTrigger.resource + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | - - - - - - - - - -
DescriptionThe name or pattern of the resource to trigger on
TypeString
+**Description:** A function triggered by a Cloud Task +
+
+
+ + 18.1.4.11. [Optional] Property root > resources > resources items > properties > buildConfig + +
-### resources.properties.eventTrigger.eventFilters +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** Build configuration for a gen 2 Cloud Function - - - - - - - - - -
DescriptionFilters that further limit the events to listen to.
TypeArray
+
+ + 18.1.4.11.1. [Optional] Property root > resources > resources items > properties > buildConfig > runtime + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### resources.properties.eventTrigger.eventFilters.attribute +**Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. +
+
- - - - - - - - - -
DescriptionThe event attribute to filter on
TypeString
+
+ + 18.1.4.11.2. [Optional] Property root > resources > resources items > properties > buildConfig > entryPoint + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The entry point for a function resource -### resources.properties.eventTrigger.eventFilters.value +
+
+
+
- - - - - - - - - -
DescriptionThe value to filter for
TypeString
+
+ + 18.1.4.12. [Optional] Property root > resources > resources items > properties > serviceConfig + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** Service configuration for a gen 2 Cloud Function +
+ + 18.1.4.12.1. [Optional] Property root > resources > resources items > properties > serviceConfig > timeoutSeconds -### resources.properties.eventTrigger.channel + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionThe name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel.
TypeString
+**Description:** The function's maximum execution time. Default: 60, max value: 540. +
+
+
+ + 18.1.4.12.2. [Optional] Property root > resources > resources items > properties > serviceConfig > availableMemory + +
-### resources.properties.eventTrigger.triggerRegion +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes. - - - - - - - - - -
DescriptionThe trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
TypeString
+
+
+
+
+
+
+
+
+
+ + 19. [Optional] Property root > lifecycleEvents -### resources.properties.scheduleTrigger + +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | - - - - - - - - - -
DescriptionA function triggered at a regular interval by a Cloud Scheduler job
TypeObject
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ---------------------------------------- | ----------- | +| [lifecycleEvent](#lifecycleEvents_items) | - | +### 19.1. root > lifecycleEvents > lifecycleEvent -### resources.properties.scheduleTrigger.schedule +| | | +| ------------------------- | ---------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/lifecycleEvent | +
+ + 19.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall - - - - - - - - - -
DescriptionThe frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax.
TypeString
+ +
+| | | +| ------------------------- | -------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/lifecycleEventSpec | +
+ + 19.1.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > function + +
-### resources.properties.scheduleTrigger.timeZone +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section. - - - - - - - - - -
DescriptionThe time zone in which the schedule will run. Defaults to UTC.
TypeString
+
+
+
+ + 19.1.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Message to display in the Firebase console while the task is in progress. -### resources.properties.taskQueueTrigger +
+
+
+
- - - - - - - - - -
DescriptionA function triggered by a Cloud Task
TypeObject
+
+ + 19.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onUpdate + +
+| | | +| ------------------------- | --------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | +
+
-### resources.properties.buildConfig +
+ + 19.1.3. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onConfigure + +
- - - - - - - - - -
DescriptionBuild configuration for a gen 2 Cloud Function
TypeObject
+| | | +| ------------------------- | --------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | +
+
+
+
-### resources.properties.buildConfig.runtime +
+ + 20. [Optional] Property root > events + +
- - - - - - - - - -
DescriptionRuntime environment for the function. Defaults to the most recent LTS version of node.
TypeString
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------- | ----------- | +| [event](#events_items) | - | +### 20.1. root > events > event -### resources.properties.buildConfig.entryPoint +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/event | +
+ + 20.1.1. [Optional] Property root > events > events items > type - - - - - - - - - -
DescriptionThe entry point for a function resource
TypeString
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish. +
+
+
+ + 20.1.2. [Optional] Property root > events > events items > description -### resources.properties.serviceConfig + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionService configuration for a gen 2 Cloud Function
TypeObject
+**Description:** A description of the event +
+
+
+
-### resources.properties.serviceConfig.timeoutSeconds - - - - - - - - - - - -
DescriptionThe function's maximum execution time. Default: 60, max value: 540.
TypeString
- - - - -### resources.properties.serviceConfig.availableMemory - - - - - - - - - - - -
DescriptionThe amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes.
TypeString
- - - - - - - -## lifecycleEvents - - - - - - - - - - - -
TypeArray
RequiredNo
- - - -### lifecycleEvents.onInstall - - - - - - - -
TypeObject
- - - -### lifecycleEvents.onInstall.function - - - - - - - - - - - -
DescriptionName of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section.
TypeString
- - - - -### lifecycleEvents.onInstall.processingMessage - - - - - - - - - - - -
DescriptionMessage to display in the Firebase console while the task is in progress.
TypeString
- - - - - -### lifecycleEvents.onUpdate - - - - - - - -
TypeObject
- - - -### lifecycleEvents.onUpdate.function - - - - - - - - - - - -
DescriptionName of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section.
TypeString
- - - - -### lifecycleEvents.onUpdate.processingMessage - - - - - - - - - - - -
DescriptionMessage to display in the Firebase console while the task is in progress.
TypeString
- - - - - -### lifecycleEvents.onConfigure - - - - - - - -
TypeObject
- - - -### lifecycleEvents.onConfigure.function - - - - - - - - - - - -
DescriptionName of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section.
TypeString
- - - - -### lifecycleEvents.onConfigure.processingMessage - - - - - - - - - - - -
DescriptionMessage to display in the Firebase console while the task is in progress.
TypeString
- - - - - - -## events - - - - - - - - - - - -
TypeArray
RequiredNo
- - - -### events.type - - - - - - - - - - - -
DescriptionThe type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish.
TypeString
- - - - -### events.description - - - - - - - - - - - -
DescriptionA description of the event
TypeString
- - - - - - - - - - -
- -## Schema -``` -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "extension.yaml", - "additionalProperties": false, - "definitions": { - "author": { - "additionalProperties": false, - "type": "object", - "properties": { - "authorName": { - "type": "string", - "description": "The author's name" - }, - "email": { - "type": "string", - "description": "A contact email for the author" - }, - "url": { - "type": "string", - "description": "URL of the author's website" - } - } - }, - "role": { - "additionalProperties": false, - "type": "object", - "description": "An IAM role to grant to this extension.", - "properties": { - "role": { - "type": "string", - "description": "Name of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles", - "pattern": "[a-zA-Z]+\\.[a-zA-Z]+" - }, - "reason": { - "type": "string", - "description": "Why this extension needs this IAM role" - }, - "resource": { - "type": "string", - "description": "What resource to grant this role on. If omitted, defaults to projects/${project_id}" - } - }, - "required": [ - "role", - "reason" - ] - }, - "api": { - "additionalProperties": false, - "type": "object", - "description": "A Google API used by this extension. Will be enabled on extension deployment.", - "properties": { - "apiName": { - "type": "string", - "description": "Name of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library", - "pattern": "[^\\.]+\\.googleapis\\.com" - }, - "reason": { - "type": "string", - "description": "Why this extension needs this API enabled" - } - }, - "required": [ - "apiName", - "reason" - ] - }, - "externalService": { - "additionalProperties": false, - "type": "object", - "description": "A non-Google API used by this extension", - "properties": { - "name": { - "type": "string", - "description": "Name of the external service" - }, - "pricingUri": { - "type": "string", - "description": "URI to pricing information for the service" - } - } - }, - "param": { - "additionalProperties": false, - "type": "object", - "description": "A parameter that users installing this extension can configure", - "properties": { - "param": { - "type": "string", - "description": "The name of the param. This is how you reference the param in your code" - }, - "label": { - "type": "string", - "description": "Short description for the parameter. Displayed to users when they're prompted for the parameter's value." - }, - "description": { - "type": "string", - "description": "Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value." - }, - "example": { - "type": "string", - "description": "Example value for the parameter." - }, - "validationRegex": { - "type": "string", - "description": "Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax." - }, - "validationErrorMessage": { - "type": "string", - "description": "Error message to display if regex validation fails." - }, - "default": { - "type": "string", - "description": "Default value for the parameter if the user leaves the parameter's value blank." - }, - "required": { - "type": "boolean", - "description": "Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true." - }, - "immutable": { - "type": "boolean", - "description": "Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false." - }, - "advanced": { - "type": "boolean", - "description": "Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param." - }, - "type": { - "type": "string", - "description": "The parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details.", - "pattern": "string|select|multiSelect|secret|selectResource" - }, - "resourceType": { - "type": "string", - "description": "The type of resource to prompt the user to select. Provides a special UI treatment for the param.", - "pattern": "storage\\.googleapis\\.com\\/Bucket|firestore\\.googleapis\\.com\\/Database|firebasedatabase\\.googleapis\\.com\\/DatabaseInstance" - }, - "options": { - "type": "array", - "description": "Options for a select or multiSelect type param.", - "items": { - "$ref": "#/definitions/paramOption" - } - } - }, - "required": [ - "param" - ] - }, - "paramOption": { - "additionalProperties": false, - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "One of the values the user can choose. This is the value you get when you read the parameter value in code." - }, - "label": { - "type": "string", - "description": "Short description of the selectable option. If omitted, defaults to value." - } - }, - "required": [ - "value" - ] - }, - "resource": { - "additionalProperties": false, - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of this resource" - }, - "type": { - "type": "string", - "description": "What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options." - }, - "description": { - "type": "string", - "description": "A brief description of what this resource does" - }, - "properties": { - "type": "object", - "description": "The properties of this resource", - "additionalProperties": true, - "properties": { - "location": { - "type": "string", - "description": "The location for this resource" - }, - "entryPoint": { - "type": "string", - "description": "The entry point for a function resource" - }, - "sourceDirectory": { - "type": "string", - "description": "Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions" - }, - "timeout": { - "type": "string", - "description": "A function resources's maximum execution time.", - "pattern": "\\d+s" - }, - "availableMemoryMb": { - "type": "string", - "description": "Amount of memory in MB available for the function.", - "pattern": "\\d+" - }, - "runtime": { - "type": "string", - "description": "Runtime environment for the function. Defaults to the most recent LTS version of node." - }, - "httpsTrigger": { - "type": "object", - "description": "A function triggered by HTTPS calls", - "properties": {} - }, - "eventTrigger": { - "type": "object", - "description": "A function triggered by a background event", - "properties": { - "eventType": { - "type": "string", - "description": "The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list." - }, - "resource": { - "type": "string", - "description": "The name or pattern of the resource to trigger on" - }, - "eventFilters": { - "type": "array", - "description": "Filters that further limit the events to listen to.", - "items": { - "$ref": "#/definitions/eventFilter" - } - }, - "channel": { - "type": "string", - "description": "The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel." - }, - "triggerRegion": { - "type": "string", - "description": "The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function." - } - }, - "required": [ - "eventType" - ] - }, - "scheduleTrigger": { - "type": "object", - "description": "A function triggered at a regular interval by a Cloud Scheduler job", - "properties": { - "schedule": { - "type": "string", - "description": "The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax." - }, - "timeZone": { - "type": "string", - "description": "The time zone in which the schedule will run. Defaults to UTC." - } - }, - "required": [ - "schedule" - ] - }, - "taskQueueTrigger": { - "type": "object", - "description": "A function triggered by a Cloud Task", - "properties": {} - }, - "buildConfig": { - "type": "object", - "description": "Build configuration for a gen 2 Cloud Function", - "properties": { - "runtime": { - "type": "string", - "description": "Runtime environment for the function. Defaults to the most recent LTS version of node." - }, - "entryPoint": { - "type": "string", - "description": "The entry point for a function resource" - } - } - }, - "serviceConfig": { - "type": "object", - "description": "Service configuration for a gen 2 Cloud Function", - "properties": { - "timeoutSeconds": { - "type": "string", - "description": "The function's maximum execution time. Default: 60, max value: 540." - }, - "availableMemory": { - "type": "string", - "description": "The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes." - } - } - } - } - } - }, - "required": [ - "name", - "type", - "description", - "properties" - ] - }, - "lifecycleEvent": { - "type": "object", - "additionalProperties": false, - "properties": { - "onInstall": { - "$ref": "#/definitions/lifecycleEventSpec" - }, - "onUpdate": { - "$ref": "#/definitions/lifecycleEventSpec" - }, - "onConfigure": { - "$ref": "#/definitions/lifecycleEventSpec" - } - } - }, - "lifecycleEventSpec": { - "type": "object", - "additionalProperties": false, - "properties": { - "function": { - "type": "string", - "description": "Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section." - }, - "processingMessage": { - "type": "string", - "description": "Message to display in the Firebase console while the task is in progress." - } - } - }, - "event": { - "type": "object", - "additionalProperties": false, - "properties": { - "type": { - "type": "string", - "description": "The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish." - }, - "description": { - "type": "string", - "description": "A description of the event" - } - } - }, - "eventFilter": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "The event attribute to filter on" - }, - "value": { - "type": "string", - "description": "The value to filter for" - } - } - } - }, - "properties": { - "name": { - "type": "string", - "description": "ID of this extension (ie your-extension-name)" - }, - "version": { - "type": "string", - "description": "Version of this extension. Follows https://semver.org/." - }, - "specVersion": { - "type": "string", - "description": "Version of the extension.yaml spec that this file follows. Currently always 'v1beta'" - }, - "license": { - "type": "string", - "description": "The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev" - }, - "displayName": { - "type": "string", - "description": "Human readable name for this extension (ie 'Your Extension Name')" - }, - "description": { - "type": "string", - "description": "A one to two sentence description of what this extension does" - }, - "icon": { - "type": "string", - "description": "The file name of this extension's icon" - }, - "billingRequired": { - "type": "boolean", - "description": "Whether this extension requires a billing to be enabled on the project it is installed on" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of tags to help users find your extension in search" - }, - "sourceUrl": { - "type": "string", - "description": "The URL of the GitHub repo hosting this code" - }, - "releaseNotesUrl": { - "type": "string", - "description": "A URL where users can view the full changelog or release notes for this extension" - }, - "author": { - "$ref": "#/definitions/author" - }, - "contributors": { - "type": "array", - "items": { - "$ref": "#/definitions/author" - } - }, - "apis": { - "type": "array", - "items": { - "$ref": "#/definitions/api" - } - }, - "roles": { - "type": "array", - "items": { - "$ref": "#/definitions/role" - } - }, - "externalServices": { - "type": "array", - "items": { - "$ref": "#/definitions/externalService" - } - }, - "params": { - "type": "array", - "items": { - "$ref": "#/definitions/param" - } - }, - "resources": { - "type": "array", - "items": { - "$ref": "#/definitions/resource" - } - }, - "lifecycleEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/lifecycleEvent" - } - }, - "events": { - "type": "array", - "items": { - "$ref": "#/definitions/event" - } - } - } -} -``` - - +---------------------------------------------------------------------------------------------------------------------------- +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md index 3fce5b7f617..cf8e8dd1d25 100644 --- a/schema/docs/firebase-config.md +++ b/schema/docs/firebase-config.md @@ -1,5445 +1,7441 @@ +# Schema Docs + +- [1. [Optional] Property root > $schema](#schema) +- [2. [Optional] Property root > apphosting](#apphosting) + - [2.1. Property `root > apphosting > anyOf > item 0`](#apphosting_anyOf_i0) + - [2.1.1. [Optional] Property root > apphosting > anyOf > item 0 > alwaysDeployFromSource](#apphosting_anyOf_i0_alwaysDeployFromSource) + - [2.1.2. [Required] Property root > apphosting > anyOf > item 0 > backendId](#apphosting_anyOf_i0_backendId) + - [2.1.3. [Required] Property root > apphosting > anyOf > item 0 > ignore](#apphosting_anyOf_i0_ignore) + - [2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_2) + - [2.1.4. [Required] Property root > apphosting > anyOf > item 0 > rootDir](#apphosting_anyOf_i0_rootDir) + - [2.2. Property `root > apphosting > anyOf > item 1`](#apphosting_anyOf_i1) + - [2.2.1. root > apphosting > anyOf > item 1 > item 1 items](#autogenerated_heading_3) + - [2.2.1.1. [Optional] Property root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource](#apphosting_anyOf_i1_items_alwaysDeployFromSource) + - [2.2.1.2. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > backendId](#apphosting_anyOf_i1_items_backendId) + - [2.2.1.3. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > ignore](#apphosting_anyOf_i1_items_ignore) + - [2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items](#autogenerated_heading_4) + - [2.2.1.4. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > rootDir](#apphosting_anyOf_i1_items_rootDir) +- [3. [Optional] Property root > database](#database) + - [3.1. Property `root > database > anyOf > DatabaseSingle`](#database_anyOf_i0) + - [3.1.1. [Optional] Property root > database > anyOf > item 0 > postdeploy](#database_anyOf_i0_postdeploy) + - [3.1.1.1. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 0`](#database_anyOf_i0_postdeploy_anyOf_i0) + - [3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_5) + - [3.1.1.2. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 1`](#database_anyOf_i0_postdeploy_anyOf_i1) + - [3.1.2. [Optional] Property root > database > anyOf > item 0 > predeploy](#database_anyOf_i0_predeploy) + - [3.1.2.1. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 0`](#database_anyOf_i0_predeploy_anyOf_i0) + - [3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_6) + - [3.1.2.2. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 1`](#database_anyOf_i0_predeploy_anyOf_i1) + - [3.1.3. [Required] Property root > database > anyOf > item 0 > rules](#database_anyOf_i0_rules) + - [3.2. Property `root > database > anyOf > item 1`](#database_anyOf_i1) + - [3.2.1. root > database > anyOf > item 1 > item 1 items](#autogenerated_heading_7) + - [3.2.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0) + - [3.2.1.1.1. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance](#database_anyOf_i1_items_anyOf_i0_instance) + - [3.2.1.1.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy](#database_anyOf_i1_items_anyOf_i0_postdeploy) + - [3.2.1.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) + - [3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_8) + - [3.2.1.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) + - [3.2.1.1.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy](#database_anyOf_i1_items_anyOf_i0_predeploy) + - [3.2.1.1.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) + - [3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_9) + - [3.2.1.1.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) + - [3.2.1.1.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules](#database_anyOf_i1_items_anyOf_i0_rules) + - [3.2.1.1.5. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target](#database_anyOf_i1_items_anyOf_i0_target) + - [3.2.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1) + - [3.2.1.2.1. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance](#database_anyOf_i1_items_anyOf_i1_instance) + - [3.2.1.2.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy](#database_anyOf_i1_items_anyOf_i1_postdeploy) + - [3.2.1.2.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) + - [3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_10) + - [3.2.1.2.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) + - [3.2.1.2.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy](#database_anyOf_i1_items_anyOf_i1_predeploy) + - [3.2.1.2.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) + - [3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_11) + - [3.2.1.2.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) + - [3.2.1.2.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules](#database_anyOf_i1_items_anyOf_i1_rules) + - [3.2.1.2.5. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target](#database_anyOf_i1_items_anyOf_i1_target) +- [4. [Optional] Property root > dataconnect](#dataconnect) + - [4.1. Property `root > dataconnect > anyOf > DataConnectSingle`](#dataconnect_anyOf_i0) + - [4.1.1. [Optional] Property root > dataconnect > anyOf > item 0 > postdeploy](#dataconnect_anyOf_i0_postdeploy) + - [4.1.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0`](#dataconnect_anyOf_i0_postdeploy_anyOf_i0) + - [4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_12) + - [4.1.1.2. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 1`](#dataconnect_anyOf_i0_postdeploy_anyOf_i1) + - [4.1.2. [Optional] Property root > dataconnect > anyOf > item 0 > predeploy](#dataconnect_anyOf_i0_predeploy) + - [4.1.2.1. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0`](#dataconnect_anyOf_i0_predeploy_anyOf_i0) + - [4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_13) + - [4.1.2.2. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 1`](#dataconnect_anyOf_i0_predeploy_anyOf_i1) + - [4.1.3. [Required] Property root > dataconnect > anyOf > item 0 > source](#dataconnect_anyOf_i0_source) + - [4.2. Property `root > dataconnect > anyOf > item 1`](#dataconnect_anyOf_i1) + - [4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle](#autogenerated_heading_14) +- [5. [Optional] Property root > emulators](#emulators) + - [5.1. [Optional] Property root > emulators > apphosting](#emulators_apphosting) + - [5.1.1. [Optional] Property root > emulators > apphosting > host](#emulators_apphosting_host) + - [5.1.2. [Optional] Property root > emulators > apphosting > port](#emulators_apphosting_port) + - [5.1.3. [Optional] Property root > emulators > apphosting > rootDirectory](#emulators_apphosting_rootDirectory) + - [5.1.4. [Optional] Property root > emulators > apphosting > startCommand](#emulators_apphosting_startCommand) + - [5.1.5. [Optional] Property root > emulators > apphosting > startCommandOverride](#emulators_apphosting_startCommandOverride) + - [5.2. [Optional] Property root > emulators > auth](#emulators_auth) + - [5.2.1. [Optional] Property root > emulators > auth > host](#emulators_auth_host) + - [5.2.2. [Optional] Property root > emulators > auth > port](#emulators_auth_port) + - [5.3. [Optional] Property root > emulators > database](#emulators_database) + - [5.3.1. [Optional] Property root > emulators > database > host](#emulators_database_host) + - [5.3.2. [Optional] Property root > emulators > database > port](#emulators_database_port) + - [5.4. [Optional] Property root > emulators > dataconnect](#emulators_dataconnect) + - [5.4.1. [Optional] Property root > emulators > dataconnect > dataDir](#emulators_dataconnect_dataDir) + - [5.4.2. [Optional] Property root > emulators > dataconnect > host](#emulators_dataconnect_host) + - [5.4.3. [Optional] Property root > emulators > dataconnect > port](#emulators_dataconnect_port) + - [5.4.4. [Optional] Property root > emulators > dataconnect > postgresHost](#emulators_dataconnect_postgresHost) + - [5.4.5. [Optional] Property root > emulators > dataconnect > postgresPort](#emulators_dataconnect_postgresPort) + - [5.5. [Optional] Property root > emulators > eventarc](#emulators_eventarc) + - [5.5.1. [Optional] Property root > emulators > eventarc > host](#emulators_eventarc_host) + - [5.5.2. [Optional] Property root > emulators > eventarc > port](#emulators_eventarc_port) + - [5.6. [Optional] Property root > emulators > extensions](#emulators_extensions) + - [5.7. [Optional] Property root > emulators > firestore](#emulators_firestore) + - [5.7.1. [Optional] Property root > emulators > firestore > host](#emulators_firestore_host) + - [5.7.2. [Optional] Property root > emulators > firestore > port](#emulators_firestore_port) + - [5.7.3. [Optional] Property root > emulators > firestore > websocketPort](#emulators_firestore_websocketPort) + - [5.8. [Optional] Property root > emulators > hosting](#emulators_hosting) + - [5.8.1. [Optional] Property root > emulators > hosting > host](#emulators_hosting_host) + - [5.8.2. [Optional] Property root > emulators > hosting > port](#emulators_hosting_port) + - [5.9. [Optional] Property root > emulators > hub](#emulators_hub) + - [5.9.1. [Optional] Property root > emulators > hub > host](#emulators_hub_host) + - [5.9.2. [Optional] Property root > emulators > hub > port](#emulators_hub_port) + - [5.10. [Optional] Property root > emulators > logging](#emulators_logging) + - [5.10.1. [Optional] Property root > emulators > logging > host](#emulators_logging_host) + - [5.10.2. [Optional] Property root > emulators > logging > port](#emulators_logging_port) + - [5.11. [Optional] Property root > emulators > pubsub](#emulators_pubsub) + - [5.11.1. [Optional] Property root > emulators > pubsub > host](#emulators_pubsub_host) + - [5.11.2. [Optional] Property root > emulators > pubsub > port](#emulators_pubsub_port) + - [5.12. [Optional] Property root > emulators > singleProjectMode](#emulators_singleProjectMode) + - [5.13. [Optional] Property root > emulators > storage](#emulators_storage) + - [5.13.1. [Optional] Property root > emulators > storage > host](#emulators_storage_host) + - [5.13.2. [Optional] Property root > emulators > storage > port](#emulators_storage_port) + - [5.14. [Optional] Property root > emulators > tasks](#emulators_tasks) + - [5.14.1. [Optional] Property root > emulators > tasks > host](#emulators_tasks_host) + - [5.14.2. [Optional] Property root > emulators > tasks > port](#emulators_tasks_port) + - [5.15. [Optional] Property root > emulators > ui](#emulators_ui) + - [5.15.1. [Optional] Property root > emulators > ui > enabled](#emulators_ui_enabled) + - [5.15.2. [Optional] Property root > emulators > ui > host](#emulators_ui_host) + - [5.15.3. [Optional] Property root > emulators > ui > port](#emulators_ui_port) +- [6. [Optional] Property root > extensions](#extensions) +- [7. [Optional] Property root > firestore](#firestore) + - [7.1. Property `root > firestore > anyOf > FirestoreSingle`](#firestore_anyOf_i0) + - [7.1.1. [Optional] Property root > firestore > anyOf > item 0 > database](#firestore_anyOf_i0_database) + - [7.1.2. [Optional] Property root > firestore > anyOf > item 0 > indexes](#firestore_anyOf_i0_indexes) + - [7.1.3. [Optional] Property root > firestore > anyOf > item 0 > location](#firestore_anyOf_i0_location) + - [7.1.4. [Optional] Property root > firestore > anyOf > item 0 > postdeploy](#firestore_anyOf_i0_postdeploy) + - [7.1.4.1. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0`](#firestore_anyOf_i0_postdeploy_anyOf_i0) + - [7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_15) + - [7.1.4.2. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 1`](#firestore_anyOf_i0_postdeploy_anyOf_i1) + - [7.1.5. [Optional] Property root > firestore > anyOf > item 0 > predeploy](#firestore_anyOf_i0_predeploy) + - [7.1.5.1. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 0`](#firestore_anyOf_i0_predeploy_anyOf_i0) + - [7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_16) + - [7.1.5.2. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 1`](#firestore_anyOf_i0_predeploy_anyOf_i1) + - [7.1.6. [Optional] Property root > firestore > anyOf > item 0 > rules](#firestore_anyOf_i0_rules) + - [7.2. Property `root > firestore > anyOf > item 1`](#firestore_anyOf_i1) + - [7.2.1. root > firestore > anyOf > item 1 > item 1 items](#autogenerated_heading_17) + - [7.2.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0) + - [7.2.1.1.1. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database](#firestore_anyOf_i1_items_anyOf_i0_database) + - [7.2.1.1.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes](#firestore_anyOf_i1_items_anyOf_i0_indexes) + - [7.2.1.1.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy](#firestore_anyOf_i1_items_anyOf_i0_postdeploy) + - [7.2.1.1.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) + - [7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_18) + - [7.2.1.1.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) + - [7.2.1.1.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy](#firestore_anyOf_i1_items_anyOf_i0_predeploy) + - [7.2.1.1.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) + - [7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_19) + - [7.2.1.1.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) + - [7.2.1.1.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules](#firestore_anyOf_i1_items_anyOf_i0_rules) + - [7.2.1.1.6. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target](#firestore_anyOf_i1_items_anyOf_i0_target) + - [7.2.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1) + - [7.2.1.2.1. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database](#firestore_anyOf_i1_items_anyOf_i1_database) + - [7.2.1.2.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes](#firestore_anyOf_i1_items_anyOf_i1_indexes) + - [7.2.1.2.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy](#firestore_anyOf_i1_items_anyOf_i1_postdeploy) + - [7.2.1.2.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) + - [7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_20) + - [7.2.1.2.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) + - [7.2.1.2.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy](#firestore_anyOf_i1_items_anyOf_i1_predeploy) + - [7.2.1.2.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) + - [7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_21) + - [7.2.1.2.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) + - [7.2.1.2.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules](#firestore_anyOf_i1_items_anyOf_i1_rules) + - [7.2.1.2.6. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target](#firestore_anyOf_i1_items_anyOf_i1_target) +- [8. [Optional] Property root > functions](#functions) + - [8.1. Property `root > functions > anyOf > FunctionConfig`](#functions_anyOf_i0) + - [8.1.1. [Optional] Property root > functions > anyOf > item 0 > codebase](#functions_anyOf_i0_codebase) + - [8.1.2. [Optional] Property root > functions > anyOf > item 0 > ignore](#functions_anyOf_i0_ignore) + - [8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_22) + - [8.1.3. [Optional] Property root > functions > anyOf > item 0 > postdeploy](#functions_anyOf_i0_postdeploy) + - [8.1.3.1. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 0`](#functions_anyOf_i0_postdeploy_anyOf_i0) + - [8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_23) + - [8.1.3.2. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 1`](#functions_anyOf_i0_postdeploy_anyOf_i1) + - [8.1.4. [Optional] Property root > functions > anyOf > item 0 > predeploy](#functions_anyOf_i0_predeploy) + - [8.1.4.1. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 0`](#functions_anyOf_i0_predeploy_anyOf_i0) + - [8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_24) + - [8.1.4.2. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 1`](#functions_anyOf_i0_predeploy_anyOf_i1) + - [8.1.5. [Optional] Property root > functions > anyOf > item 0 > runtime](#functions_anyOf_i0_runtime) + - [8.1.6. [Optional] Property root > functions > anyOf > item 0 > source](#functions_anyOf_i0_source) + - [8.2. Property `root > functions > anyOf > item 1`](#functions_anyOf_i1) + - [8.2.1. root > functions > anyOf > item 1 > FunctionConfig](#autogenerated_heading_25) +- [9. [Optional] Property root > hosting](#hosting) + - [9.1. Property `root > hosting > anyOf > HostingSingle`](#hosting_anyOf_i0) + - [9.1.1. [Optional] Property root > hosting > anyOf > item 0 > appAssociation](#hosting_anyOf_i0_appAssociation) + - [9.1.2. [Optional] Property root > hosting > anyOf > item 0 > cleanUrls](#hosting_anyOf_i0_cleanUrls) + - [9.1.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend](#hosting_anyOf_i0_frameworksBackend) + - [9.1.3.1. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > concurrency](#hosting_anyOf_i0_frameworksBackend_concurrency) + - [9.1.3.2. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cors](#hosting_anyOf_i0_frameworksBackend_cors) + - [9.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cpu](#hosting_anyOf_i0_frameworksBackend_cpu) + - [9.1.3.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 0`](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i0) + - [9.1.3.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 1`](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i1) + - [9.1.3.4. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck](#hosting_anyOf_i0_frameworksBackend_enforceAppCheck) + - [9.1.3.5. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings](#hosting_anyOf_i0_frameworksBackend_ingressSettings) + - [9.1.3.6. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > invoker](#hosting_anyOf_i0_frameworksBackend_invoker) + - [9.1.3.7. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > labels](#hosting_anyOf_i0_frameworksBackend_labels) + - [9.1.3.8. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > maxInstances](#hosting_anyOf_i0_frameworksBackend_maxInstances) + - [9.1.3.9. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > memory](#hosting_anyOf_i0_frameworksBackend_memory) + - [9.1.3.10. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > minInstances](#hosting_anyOf_i0_frameworksBackend_minInstances) + - [9.1.3.11. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > omit](#hosting_anyOf_i0_frameworksBackend_omit) + - [9.1.3.12. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges](#hosting_anyOf_i0_frameworksBackend_preserveExternalChanges) + - [9.1.3.13. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > region](#hosting_anyOf_i0_frameworksBackend_region) + - [9.1.3.14. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > secrets](#hosting_anyOf_i0_frameworksBackend_secrets) + - [9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items](#autogenerated_heading_26) + - [9.1.3.15. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount](#hosting_anyOf_i0_frameworksBackend_serviceAccount) + - [9.1.3.16. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds](#hosting_anyOf_i0_frameworksBackend_timeoutSeconds) + - [9.1.3.17. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector](#hosting_anyOf_i0_frameworksBackend_vpcConnector) + - [9.1.3.18. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings](#hosting_anyOf_i0_frameworksBackend_vpcConnectorEgressSettings) + - [9.1.4. [Optional] Property root > hosting > anyOf > item 0 > headers](#hosting_anyOf_i0_headers) + - [9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders](#autogenerated_heading_27) + - [9.1.4.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0`](#hosting_anyOf_i0_headers_items_anyOf_i0) + - [9.1.4.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob](#hosting_anyOf_i0_headers_items_anyOf_i0_glob) + - [9.1.4.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers](#hosting_anyOf_i0_headers_items_anyOf_i0_headers) + - [9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items](#autogenerated_heading_28) + - [9.1.4.1.1.2.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_key) + - [9.1.4.1.1.2.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_value) + - [9.1.4.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1`](#hosting_anyOf_i0_headers_items_anyOf_i1) + - [9.1.4.1.2.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers](#hosting_anyOf_i0_headers_items_anyOf_i1_headers) + - [9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items](#autogenerated_heading_29) + - [9.1.4.1.2.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_key) + - [9.1.4.1.2.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_value) + - [9.1.4.1.2.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source](#hosting_anyOf_i0_headers_items_anyOf_i1_source) + - [9.1.4.1.3. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2`](#hosting_anyOf_i0_headers_items_anyOf_i2) + - [9.1.4.1.3.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers](#hosting_anyOf_i0_headers_items_anyOf_i2_headers) + - [9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items](#autogenerated_heading_30) + - [9.1.4.1.3.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_key) + - [9.1.4.1.3.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_value) + - [9.1.4.1.3.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex](#hosting_anyOf_i0_headers_items_anyOf_i2_regex) + - [9.1.5. [Optional] Property root > hosting > anyOf > item 0 > i18n](#hosting_anyOf_i0_i18n) + - [9.1.5.1. [Required] Property root > hosting > anyOf > item 0 > i18n > root](#hosting_anyOf_i0_i18n_root) + - [9.1.6. [Optional] Property root > hosting > anyOf > item 0 > ignore](#hosting_anyOf_i0_ignore) + - [9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_31) + - [9.1.7. [Optional] Property root > hosting > anyOf > item 0 > postdeploy](#hosting_anyOf_i0_postdeploy) + - [9.1.7.1. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0`](#hosting_anyOf_i0_postdeploy_anyOf_i0) + - [9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_32) + - [9.1.7.2. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 1`](#hosting_anyOf_i0_postdeploy_anyOf_i1) + - [9.1.8. [Optional] Property root > hosting > anyOf > item 0 > predeploy](#hosting_anyOf_i0_predeploy) + - [9.1.8.1. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 0`](#hosting_anyOf_i0_predeploy_anyOf_i0) + - [9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_33) + - [9.1.8.2. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 1`](#hosting_anyOf_i0_predeploy_anyOf_i1) + - [9.1.9. [Optional] Property root > hosting > anyOf > item 0 > public](#hosting_anyOf_i0_public) + - [9.1.10. [Optional] Property root > hosting > anyOf > item 0 > redirects](#hosting_anyOf_i0_redirects) + - [9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects](#autogenerated_heading_34) + - [9.1.10.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0`](#hosting_anyOf_i0_redirects_items_anyOf_i0) + - [9.1.10.1.1.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination](#hosting_anyOf_i0_redirects_items_anyOf_i0_destination) + - [9.1.10.1.1.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob](#hosting_anyOf_i0_redirects_items_anyOf_i0_glob) + - [9.1.10.1.1.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type](#hosting_anyOf_i0_redirects_items_anyOf_i0_type) + - [9.1.10.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1`](#hosting_anyOf_i0_redirects_items_anyOf_i1) + - [9.1.10.1.2.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination](#hosting_anyOf_i0_redirects_items_anyOf_i1_destination) + - [9.1.10.1.2.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source](#hosting_anyOf_i0_redirects_items_anyOf_i1_source) + - [9.1.10.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type](#hosting_anyOf_i0_redirects_items_anyOf_i1_type) + - [9.1.10.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2`](#hosting_anyOf_i0_redirects_items_anyOf_i2) + - [9.1.10.1.3.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination](#hosting_anyOf_i0_redirects_items_anyOf_i2_destination) + - [9.1.10.1.3.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex](#hosting_anyOf_i0_redirects_items_anyOf_i2_regex) + - [9.1.10.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type](#hosting_anyOf_i0_redirects_items_anyOf_i2_type) + - [9.1.11. [Optional] Property root > hosting > anyOf > item 0 > rewrites](#hosting_anyOf_i0_rewrites) + - [9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites](#autogenerated_heading_35) + - [9.1.11.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0`](#hosting_anyOf_i0_rewrites_items_anyOf_i0) + - [9.1.11.1.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination](#hosting_anyOf_i0_rewrites_items_anyOf_i0_destination) + - [9.1.11.1.1.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i0_glob) + - [9.1.11.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1`](#hosting_anyOf_i0_rewrites_items_anyOf_i1) + - [9.1.11.1.2.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i1_function) + - [9.1.11.1.2.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i1_glob) + - [9.1.11.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region](#hosting_anyOf_i0_rewrites_items_anyOf_i1_region) + - [9.1.11.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2`](#hosting_anyOf_i0_rewrites_items_anyOf_i2) + - [9.1.11.1.3.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function) + - [9.1.11.1.3.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_functionId) + - [9.1.11.1.3.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_pinTag) + - [9.1.11.1.3.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_region) + - [9.1.11.1.3.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i2_glob) + - [9.1.11.1.4. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3`](#hosting_anyOf_i0_rewrites_items_anyOf_i3) + - [9.1.11.1.4.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i3_glob) + - [9.1.11.1.4.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run) + - [9.1.11.1.4.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_pinTag) + - [9.1.11.1.4.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_region) + - [9.1.11.1.4.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_serviceId) + - [9.1.11.1.5. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4`](#hosting_anyOf_i0_rewrites_items_anyOf_i4) + - [9.1.11.1.5.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i4_dynamicLinks) + - [9.1.11.1.5.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i4_glob) + - [9.1.11.1.6. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5`](#hosting_anyOf_i0_rewrites_items_anyOf_i5) + - [9.1.11.1.6.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination](#hosting_anyOf_i0_rewrites_items_anyOf_i5_destination) + - [9.1.11.1.6.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i5_source) + - [9.1.11.1.7. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6`](#hosting_anyOf_i0_rewrites_items_anyOf_i6) + - [9.1.11.1.7.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i6_function) + - [9.1.11.1.7.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region](#hosting_anyOf_i0_rewrites_items_anyOf_i6_region) + - [9.1.11.1.7.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i6_source) + - [9.1.11.1.8. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7`](#hosting_anyOf_i0_rewrites_items_anyOf_i7) + - [9.1.11.1.8.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function) + - [9.1.11.1.8.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_functionId) + - [9.1.11.1.8.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_pinTag) + - [9.1.11.1.8.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_region) + - [9.1.11.1.8.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i7_source) + - [9.1.11.1.9. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8`](#hosting_anyOf_i0_rewrites_items_anyOf_i8) + - [9.1.11.1.9.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run) + - [9.1.11.1.9.1.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_pinTag) + - [9.1.11.1.9.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_region) + - [9.1.11.1.9.1.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_serviceId) + - [9.1.11.1.9.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i8_source) + - [9.1.11.1.10. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9`](#hosting_anyOf_i0_rewrites_items_anyOf_i9) + - [9.1.11.1.10.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i9_dynamicLinks) + - [9.1.11.1.10.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i9_source) + - [9.1.11.1.11. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10`](#hosting_anyOf_i0_rewrites_items_anyOf_i10) + - [9.1.11.1.11.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination](#hosting_anyOf_i0_rewrites_items_anyOf_i10_destination) + - [9.1.11.1.11.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i10_regex) + - [9.1.11.1.12. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11`](#hosting_anyOf_i0_rewrites_items_anyOf_i11) + - [9.1.11.1.12.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i11_function) + - [9.1.11.1.12.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i11_regex) + - [9.1.11.1.12.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region](#hosting_anyOf_i0_rewrites_items_anyOf_i11_region) + - [9.1.11.1.13. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12`](#hosting_anyOf_i0_rewrites_items_anyOf_i12) + - [9.1.11.1.13.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function) + - [9.1.11.1.13.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_functionId) + - [9.1.11.1.13.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_pinTag) + - [9.1.11.1.13.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_region) + - [9.1.11.1.13.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i12_regex) + - [9.1.11.1.14. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13`](#hosting_anyOf_i0_rewrites_items_anyOf_i13) + - [9.1.11.1.14.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i13_regex) + - [9.1.11.1.14.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run) + - [9.1.11.1.14.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_pinTag) + - [9.1.11.1.14.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_region) + - [9.1.11.1.14.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_serviceId) + - [9.1.11.1.15. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14`](#hosting_anyOf_i0_rewrites_items_anyOf_i14) + - [9.1.11.1.15.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i14_dynamicLinks) + - [9.1.11.1.15.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i14_regex) + - [9.1.12. [Optional] Property root > hosting > anyOf > item 0 > site](#hosting_anyOf_i0_site) + - [9.1.13. [Optional] Property root > hosting > anyOf > item 0 > source](#hosting_anyOf_i0_source) + - [9.1.14. [Optional] Property root > hosting > anyOf > item 0 > target](#hosting_anyOf_i0_target) + - [9.1.15. [Optional] Property root > hosting > anyOf > item 0 > trailingSlash](#hosting_anyOf_i0_trailingSlash) + - [9.2. Property `root > hosting > anyOf > item 1`](#hosting_anyOf_i1) + - [9.2.1. root > hosting > anyOf > item 1 > item 1 items](#autogenerated_heading_36) + - [9.2.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0) + - [9.2.1.1.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation](#hosting_anyOf_i1_items_anyOf_i0_appAssociation) + - [9.2.1.1.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls](#hosting_anyOf_i1_items_anyOf_i0_cleanUrls) + - [9.2.1.1.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend](#hosting_anyOf_i1_items_anyOf_i0_frameworksBackend) + - [9.2.1.1.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers](#hosting_anyOf_i1_items_anyOf_i0_headers) + - [9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders](#autogenerated_heading_37) + - [9.2.1.1.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n](#hosting_anyOf_i1_items_anyOf_i0_i18n) + - [9.2.1.1.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root](#hosting_anyOf_i1_items_anyOf_i0_i18n_root) + - [9.2.1.1.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore](#hosting_anyOf_i1_items_anyOf_i0_ignore) + - [9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_38) + - [9.2.1.1.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy](#hosting_anyOf_i1_items_anyOf_i0_postdeploy) + - [9.2.1.1.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) + - [9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_39) + - [9.2.1.1.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) + - [9.2.1.1.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy](#hosting_anyOf_i1_items_anyOf_i0_predeploy) + - [9.2.1.1.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) + - [9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_40) + - [9.2.1.1.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) + - [9.2.1.1.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public](#hosting_anyOf_i1_items_anyOf_i0_public) + - [9.2.1.1.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects](#hosting_anyOf_i1_items_anyOf_i0_redirects) + - [9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects](#autogenerated_heading_41) + - [9.2.1.1.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites) + - [9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites](#autogenerated_heading_42) + - [9.2.1.1.12. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site](#hosting_anyOf_i1_items_anyOf_i0_site) + - [9.2.1.1.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source](#hosting_anyOf_i1_items_anyOf_i0_source) + - [9.2.1.1.14. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target](#hosting_anyOf_i1_items_anyOf_i0_target) + - [9.2.1.1.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash](#hosting_anyOf_i1_items_anyOf_i0_trailingSlash) + - [9.2.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1) + - [9.2.1.2.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation](#hosting_anyOf_i1_items_anyOf_i1_appAssociation) + - [9.2.1.2.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls](#hosting_anyOf_i1_items_anyOf_i1_cleanUrls) + - [9.2.1.2.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend](#hosting_anyOf_i1_items_anyOf_i1_frameworksBackend) + - [9.2.1.2.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers](#hosting_anyOf_i1_items_anyOf_i1_headers) + - [9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders](#autogenerated_heading_43) + - [9.2.1.2.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n](#hosting_anyOf_i1_items_anyOf_i1_i18n) + - [9.2.1.2.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root](#hosting_anyOf_i1_items_anyOf_i1_i18n_root) + - [9.2.1.2.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore](#hosting_anyOf_i1_items_anyOf_i1_ignore) + - [9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items](#autogenerated_heading_44) + - [9.2.1.2.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy](#hosting_anyOf_i1_items_anyOf_i1_postdeploy) + - [9.2.1.2.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) + - [9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_45) + - [9.2.1.2.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) + - [9.2.1.2.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy](#hosting_anyOf_i1_items_anyOf_i1_predeploy) + - [9.2.1.2.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) + - [9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_46) + - [9.2.1.2.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) + - [9.2.1.2.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public](#hosting_anyOf_i1_items_anyOf_i1_public) + - [9.2.1.2.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects](#hosting_anyOf_i1_items_anyOf_i1_redirects) + - [9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects](#autogenerated_heading_47) + - [9.2.1.2.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites) + - [9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites](#autogenerated_heading_48) + - [9.2.1.2.12. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site](#hosting_anyOf_i1_items_anyOf_i1_site) + - [9.2.1.2.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source](#hosting_anyOf_i1_items_anyOf_i1_source) + - [9.2.1.2.14. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target](#hosting_anyOf_i1_items_anyOf_i1_target) + - [9.2.1.2.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash](#hosting_anyOf_i1_items_anyOf_i1_trailingSlash) +- [10. [Optional] Property root > remoteconfig](#remoteconfig) + - [10.1. [Optional] Property root > remoteconfig > postdeploy](#remoteconfig_postdeploy) + - [10.1.1. Property `root > remoteconfig > postdeploy > anyOf > item 0`](#remoteconfig_postdeploy_anyOf_i0) + - [10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_49) + - [10.1.2. Property `root > remoteconfig > postdeploy > anyOf > item 1`](#remoteconfig_postdeploy_anyOf_i1) + - [10.2. [Optional] Property root > remoteconfig > predeploy](#remoteconfig_predeploy) + - [10.2.1. Property `root > remoteconfig > predeploy > anyOf > item 0`](#remoteconfig_predeploy_anyOf_i0) + - [10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_50) + - [10.2.2. Property `root > remoteconfig > predeploy > anyOf > item 1`](#remoteconfig_predeploy_anyOf_i1) + - [10.3. [Required] Property root > remoteconfig > template](#remoteconfig_template) +- [11. [Optional] Property root > storage](#storage) + - [11.1. Property `root > storage > anyOf > StorageSingle`](#storage_anyOf_i0) + - [11.1.1. [Optional] Property root > storage > anyOf > item 0 > postdeploy](#storage_anyOf_i0_postdeploy) + - [11.1.1.1. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 0`](#storage_anyOf_i0_postdeploy_anyOf_i0) + - [11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_51) + - [11.1.1.2. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 1`](#storage_anyOf_i0_postdeploy_anyOf_i1) + - [11.1.2. [Optional] Property root > storage > anyOf > item 0 > predeploy](#storage_anyOf_i0_predeploy) + - [11.1.2.1. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 0`](#storage_anyOf_i0_predeploy_anyOf_i0) + - [11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_52) + - [11.1.2.2. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 1`](#storage_anyOf_i0_predeploy_anyOf_i1) + - [11.1.3. [Required] Property root > storage > anyOf > item 0 > rules](#storage_anyOf_i0_rules) + - [11.1.4. [Optional] Property root > storage > anyOf > item 0 > target](#storage_anyOf_i0_target) + - [11.2. Property `root > storage > anyOf > item 1`](#storage_anyOf_i1) + - [11.2.1. root > storage > anyOf > item 1 > item 1 items](#autogenerated_heading_53) + - [11.2.1.1. [Required] Property root > storage > anyOf > item 1 > item 1 items > bucket](#storage_anyOf_i1_items_bucket) + - [11.2.1.2. [Optional] Property root > storage > anyOf > item 1 > item 1 items > postdeploy](#storage_anyOf_i1_items_postdeploy) + - [11.2.1.2.1. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0`](#storage_anyOf_i1_items_postdeploy_anyOf_i0) + - [11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_54) + - [11.2.1.2.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 1`](#storage_anyOf_i1_items_postdeploy_anyOf_i1) + - [11.2.1.3. [Optional] Property root > storage > anyOf > item 1 > item 1 items > predeploy](#storage_anyOf_i1_items_predeploy) + - [11.2.1.3.1. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0`](#storage_anyOf_i1_items_predeploy_anyOf_i0) + - [11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_55) + - [11.2.1.3.2. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 1`](#storage_anyOf_i1_items_predeploy_anyOf_i1) + - [11.2.1.4. [Required] Property root > storage > anyOf > item 1 > item 1 items > rules](#storage_anyOf_i1_items_rules) + - [11.2.1.5. [Optional] Property root > storage > anyOf > item 1 > item 1 items > target](#storage_anyOf_i1_items_target) + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +**Description:** Information about the resources in your Firebase project. +This used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start` + +
+ + 1. [Optional] Property root > $schema + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +| **Format** | `uri` | + +**Description:** Unused. Included in schema so that the schema can be applied to single files. + +
+
+ +
+ + 2. [Optional] Property root > apphosting + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** The App Hosting backend(s) that should be deployed or emulated. + +
+ +| Any of(Option) | +| ------------------------------ | +| [item 0](#apphosting_anyOf_i0) | +| [item 1](#apphosting_anyOf_i1) | + +
+ +### 2.1. Property `root > apphosting > anyOf > item 0` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +**Description:** A single App Hosting deployment configs + +
+ + 2.1.1. [Optional] Property root > apphosting > anyOf > item 0 > alwaysDeployFromSource + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** If true, this backend will only be deployed from local source, not from source control. + +
+
+ +
+ + 2.1.2. [Required] Property root > apphosting > anyOf > item 0 > backendId + +
-# Information about the resources in your Firebase project. -This used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +
+
+
+ + 2.1.3. [Required] Property root > apphosting > anyOf > item 0 > ignore - - + +
-
- -
$schemahttp://json-schema.org/draft-07/schema#
+| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | Yes | -## Properties +**Description:** A list of file paths to exclude from the archive that is uploaded for this backend. -
NameType
$schemaString
apphostingAny of:Object
Array
databaseAny of:Object
Array
dataconnectAny of:Object
Array
emulatorsObject
extensionsObject
firestoreAny of:Object
Array
functionsAny of:Object
Array
hostingAny of:Object
Array
remoteconfigObject
storageAny of:Object
Array
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------- | ----------- | +| [ignore items](#apphosting_anyOf_i0_ignore_items) | - | +##### 2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items -
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-## $schema +
+ + 2.1.4. [Required] Property root > apphosting > anyOf > item 0 > rootDir + +
- - - - - - - - - - - - - - - - -
DescriptionUnused. Included in schema so that the schema can be applied to single files.
TypeString
RequiredNo
Formaturi
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +
+
+ +
+### 2.2. Property `root > apphosting > anyOf > item 1` -## apphosting +| | | +| ------------ | ----------------- | +| **Type** | `array of object` | +| **Required** | No | +**Description:** A list of App Hosting deployment configs - - - - - - - - - - - - - -
DescriptionThe App Hosting backend(s) that should be deployed or emulated.
TypeAny of:Object
Array
RequiredNo
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------ | --------------------------------------- | +| [item 1 items](#apphosting_anyOf_i1_items) | A single App Hosting deployment configs | +#### 2.2.1. root > apphosting > anyOf > item 1 > item 1 items -### apphosting.0 +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** A single App Hosting deployment configs - - - - - - - - - -
DescriptionA single App Hosting deployment configs
TypeObject
+
+ + 2.2.1.1. [Optional] Property root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource + +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | -### apphosting.0.alwaysDeployFromSource +**Description:** If true, this backend will only be deployed from local source, not from source control. +
+
- - - - - - - - - -
DescriptionIf true, this backend will only be deployed from local source, not from source control.
TypeBoolean
+
+ + 2.2.1.2. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > backendId + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +
+
-### apphosting.0.backendId +
+ + 2.2.1.3. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > ignore + +
- - - - - -
TypeString
+| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | Yes | +**Description:** A list of file paths to exclude from the archive that is uploaded for this backend. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------------- | ----------- | +| [ignore items](#apphosting_anyOf_i1_items_ignore_items) | - | -### apphosting.0.ignore +###### 2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionA list of file paths to exclude from the archive that is uploaded for this backend.
TypeArray
+
+
+
+ + 2.2.1.4. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > rootDir + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | -### apphosting.0.rootDir +
+
+
- - - - - -
TypeString
+ + + +
+ + 3. [Optional] Property root > database + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | -### apphosting.1 +**Description:** The Realtime Database rules that should be deployed or emulated. +
- - - - - - - - - -
DescriptionA list of App Hosting deployment configs
TypeArray
+| Any of(Option) | +| ------------------------------------ | +| [DatabaseSingle](#database_anyOf_i0) | +| [item 1](#database_anyOf_i1) | +
+### 3.1. Property `root > database > anyOf > DatabaseSingle` -### apphosting.1.alwaysDeployFromSource +| | | +| ------------------------- | ---------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/DatabaseSingle | +**Description:** Deployment options for a single Realtime Database instance. - - - - - - - - - -
DescriptionIf true, this backend will only be deployed from local source, not from source control.
TypeBoolean
+
+ + 3.1.1. [Optional] Property root > database > anyOf > item 0 > postdeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. -### apphosting.1.backendId +
+| Any of(Option) | +| ------------------------------------------------ | +| [item 0](#database_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#database_anyOf_i0_postdeploy_anyOf_i1) | - - - - - -
TypeString
+
+##### 3.1.1.1. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### apphosting.1.ignore +| Each item of this array must be | Description | +| ------------------------------------------------------------ | ----------- | +| [item 0 items](#database_anyOf_i0_postdeploy_anyOf_i0_items) | - | +###### 3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items - - - - - - - - - -
DescriptionA list of file paths to exclude from the archive that is uploaded for this backend.
TypeArray
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+##### 3.1.1.2. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### apphosting.1.rootDir +
+
- - - - - -
TypeString
+
+
+
+ + 3.1.2. [Optional] Property root > database > anyOf > item 0 > predeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. +
-## database +| Any of(Option) | +| ----------------------------------------------- | +| [item 0](#database_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#database_anyOf_i0_predeploy_anyOf_i1) | +
- - - - - - - - - - - - - -
DescriptionThe Realtime Database rules that should be deployed or emulated.
TypeAny of:Object
Array
RequiredNo
+##### 3.1.2.1. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### database.0 +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------- | +| [item 0 items](#database_anyOf_i0_predeploy_anyOf_i0_items) | - | +###### 3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items - - - - - - - - - -
DescriptionDeployment options for a single Realtime Database instance.
TypeObject
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+##### 3.1.2.2. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 1` -### database.0.postdeploy +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
- - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+
+
+
+
+ + 3.1.3. [Required] Property root > database > anyOf > item 0 > rules -### database.0.postdeploy.0 + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - -
TypeArray
+**Description:** The rules files for this Realtime Database instance. +
+
+
+
+### 3.2. Property `root > database > anyOf > item 1` -### database.0.postdeploy.1 +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +**Description:** Deployment options for a list of Realtime Database instancs. - - - - - -
TypeString
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ---------------------------------------- | ----------- | +| [item 1 items](#database_anyOf_i1_items) | - | +#### 3.2.1. root > database > anyOf > item 1 > item 1 items +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +
-### database.0.predeploy +| Any of(Option) | +| ------------------------------------------- | +| [item 0](#database_anyOf_i1_items_anyOf_i0) | +| [item 1](#database_anyOf_i1_items_anyOf_i1) | +
- - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+##### 3.2.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0` +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 3.2.1.1.1. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance -### database.0.predeploy.0 + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - -
TypeArray
+**Description:** The instance that this rules files is for. +
+
+
+ + 3.2.1.1.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy + +
-### database.0.predeploy.1 +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. - - - - - -
TypeString
+
+| Any of(Option) | +| --------------------------------------------------------------- | +| [item 0](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | +
+###### 3.2.1.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -### database.0.rules +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| --------------------------------------------------------------------------- | ----------- | +| [item 0 items](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | - - - - - - - - - -
DescriptionThe rules files for this Realtime Database instance.
TypeString
+###### 3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+###### 3.2.1.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### database.1 +
+
- - - - - - - - - -
DescriptionDeployment options for a list of Realtime Database instancs.
TypeArray
+
+
+
+ + 3.2.1.1.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. -## dataconnect +
+| Any of(Option) | +| -------------------------------------------------------------- | +| [item 0](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | - - - - - - - - - - - - - -
DescriptionThe Data Connect service(s) that should be deployed or emulated.
TypeAny of:Object
Array
RequiredNo
+
+###### 3.2.1.1.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -### dataconnect.0 +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| -------------------------------------------------------------------------- | ----------- | +| [item 0 items](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | - - - - - - - - - -
DescriptionA single Data Connect deployment configs
TypeObject
+###### 3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### dataconnect.0.postdeploy +###### 3.2.1.1.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+
+
+
+
-### dataconnect.0.postdeploy.0 +
+ + 3.2.1.1.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules + +
- - - - - -
TypeArray
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The rules files for this Realtime Database instance. +
+
+
+ + 3.2.1.1.5. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target -### dataconnect.0.postdeploy.1 + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeString
+
+
+
+
+##### 3.2.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1` +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 3.2.1.2.1. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance -### dataconnect.0.predeploy + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+**Description:** The instance that this rules files is for. +
+
+
+ + 3.2.1.2.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy -### dataconnect.0.predeploy.0 + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | - - - - - -
TypeArray
+**Description:** A script or list of scripts that will be ran after this product is deployed. +
+| Any of(Option) | +| --------------------------------------------------------------- | +| [item 0](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | +| [item 1](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | +
-### dataconnect.0.predeploy.1 +###### 3.2.1.2.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | - - - - - -
TypeString
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| --------------------------------------------------------------------------- | ----------- | +| [item 0 items](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | +###### 3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### dataconnect.0.source +###### 3.2.1.2.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeString
+
+
+
+
+
+ + 3.2.1.2.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy + +
-### dataconnect.1 +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. - - - - - - - - - -
DescriptionA list of Data Connect deployment configs
TypeArray
+
+| Any of(Option) | +| -------------------------------------------------------------- | +| [item 0](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | +| [item 1](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | +
-### dataconnect.1.postdeploy +###### 3.2.1.2.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| -------------------------------------------------------------------------- | ----------- | +| [item 0 items](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | +###### 3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items -### dataconnect.1.postdeploy.0 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
- - - - - -
TypeArray
+###### 3.2.1.2.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### dataconnect.1.postdeploy.1 +
+
+
+ + 3.2.1.2.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules - - - - - -
TypeString
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The rules files for this Realtime Database instance. +
+
+
+ + 3.2.1.2.5. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target -### dataconnect.1.predeploy + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+
+
+
+
-### dataconnect.1.predeploy.0 +
+
- - - - - -
TypeArray
+
+
+
+ + 4. [Optional] Property root > dataconnect + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | -### dataconnect.1.predeploy.1 +**Description:** The Data Connect service(s) that should be deployed or emulated. +
- - - - - -
TypeString
+| Any of(Option) | +| ------------------------------------------ | +| [DataConnectSingle](#dataconnect_anyOf_i0) | +| [item 1](#dataconnect_anyOf_i1) | +
+### 4.1. Property `root > dataconnect > anyOf > DataConnectSingle` +| | | +| ------------------------- | ------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/DataConnectSingle | +**Description:** A single Data Connect deployment configs -### dataconnect.1.source +
+ + 4.1.1. [Optional] Property root > dataconnect > anyOf > item 0 > postdeploy + +
- - - - - -
TypeString
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. +
+| Any of(Option) | +| --------------------------------------------------- | +| [item 0](#dataconnect_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#dataconnect_anyOf_i0_postdeploy_anyOf_i1) | +
+##### 4.1.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0` -## emulators +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - - - - - - - - - -
DescriptionHosts, ports, and configuration options for the Firebase Emulator suite.
TypeObject
RequiredNo
+| Each item of this array must be | Description | +| --------------------------------------------------------------- | ----------- | +| [item 0 items](#dataconnect_anyOf_i0_postdeploy_anyOf_i0_items) | - | -### Properties -
NameType
apphostingObject
authObject
databaseObject
dataconnectObject
eventarcObject
extensionsObject
firestoreObject
hostingObject
hubObject
loggingObject
pubsubObject
singleProjectModeBoolean
storageObject
tasksObject
uiObject
+###### 4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### emulators.apphosting +
+
+##### 4.1.1.2. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 1` - - - - - - - - - - - - - -
DescriptionConfig for the App Hosting emulator
TypeObject
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### emulators.apphosting.host +
+
+
+ + 4.1.2. [Optional] Property root > dataconnect > anyOf > item 0 > predeploy - - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. +
-### emulators.apphosting.port +| Any of(Option) | +| -------------------------------------------------- | +| [item 0](#dataconnect_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#dataconnect_anyOf_i0_predeploy_anyOf_i1) | +
- - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+##### 4.1.2.1. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| -------------------------------------------------------------- | ----------- | +| [item 0 items](#dataconnect_anyOf_i0_predeploy_anyOf_i0_items) | - | -### emulators.apphosting.rootDirectory +###### 4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionThe root directory of your app. The start command will ran from this directory.
TypeString
RequiredNo
+
+
+##### 4.1.2.2. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
-### emulators.apphosting.startCommand +
+
+
- - - - - - - - - - - - - -
DescriptionThe command that will be run to start your app when emulating your App Hosting backend
TypeString
RequiredNo
+
+ + 4.1.3. [Required] Property root > dataconnect > anyOf > item 0 > source + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +
+
-### emulators.apphosting.startCommandOverride +
+
+### 4.2. Property `root > dataconnect > anyOf > item 1` - - - - - - - - - -
TypeString
RequiredNo
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +**Description:** A list of Data Connect deployment configs +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------ | ---------------------------------------- | +| [DataConnectSingle](#dataconnect_anyOf_i1_items) | A single Data Connect deployment configs | +#### 4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle -### emulators.auth +| | | +| ------------------------- | --------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [dataconnect_anyOf_i0](#dataconnect_anyOf_i0) | +**Description:** A single Data Connect deployment configs - - - - - - - - - - - - - -
DescriptionConfig for the Auth emulator
TypeObject
RequiredNo
+
+
+
+
-### emulators.auth.host +
+ + 5. [Optional] Property root > emulators + +
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Hosts, ports, and configuration options for the Firebase Emulator suite. +
+ + 5.1. [Optional] Property root > emulators > apphosting + +
-### emulators.auth.port +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the App Hosting emulator - - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+
+ + 5.1.1. [Optional] Property root > emulators > apphosting > host + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. +
+
-### emulators.database +
+ + 5.1.2. [Optional] Property root > emulators > apphosting > port + +
- - - - - - - - - - - - - -
DescriptionConfig for the Realtime Database emulator
TypeObject
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** The port that this emulator will serve on. +
+
-### emulators.database.host +
+ + 5.1.3. [Optional] Property root > emulators > apphosting > rootDirectory + +
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The root directory of your app. The start command will ran from this directory. +
+
+
+ + 5.1.4. [Optional] Property root > emulators > apphosting > startCommand -### emulators.database.port + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+**Description:** The command that will be run to start your app when emulating your App Hosting backend +
+
+
+ + 5.1.5. [Optional] Property root > emulators > apphosting > startCommandOverride + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### emulators.dataconnect +
+
+
+
- - - - - - - - - - - - - -
DescriptionConfig for the Data Connect emulator.
TypeObject
RequiredNo
+
+ + 5.2. [Optional] Property root > emulators > auth + +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | -### emulators.dataconnect.dataDir +**Description:** Config for the Auth emulator +
+ + 5.2.1. [Optional] Property root > emulators > auth > host - - - - - - - - - - - - - -
DescriptionThe directory to persist emulator data to. If set, data will be saved between runs automatically. -If the --import flag is used, the current data will be overwritten by the imported data.
TypeString
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. +
+
-### emulators.dataconnect.host +
+ + 5.2.2. [Optional] Property root > emulators > auth > port + +
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** The port that this emulator will serve on. +
+
+
+
-### emulators.dataconnect.port +
+ + 5.3. [Optional] Property root > emulators > database + +
- - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the Realtime Database emulator +
+ + 5.3.1. [Optional] Property root > emulators > database > host + +
-### emulators.dataconnect.postgresHost +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. - - - - - - - - - - - - - -
DescriptionHost for the Postgres database that backs the Data Connect emulator.
TypeString
RequiredNo
+
+
+
+ + 5.3.2. [Optional] Property root > emulators > database > port + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | -### emulators.dataconnect.postgresPort +**Description:** The port that this emulator will serve on. +
+
- - - - - - - - - - - - - -
DescriptionPort for the Postgres database that backs the Data Connect emulator.
TypeNumber
RequiredNo
+
+
+
+ + 5.4. [Optional] Property root > emulators > dataconnect + +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the Data Connect emulator. -### emulators.eventarc +
+ + 5.4.1. [Optional] Property root > emulators > dataconnect > dataDir + +
- - - - - - - - - - - - - -
DescriptionConfig for the EventArc emulator.
TypeObject
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The directory to persist emulator data to. If set, data will be saved between runs automatically. +If the --import flag is used, the current data will be overwritten by the imported data. +
+
-### emulators.eventarc.host +
+ + 5.4.2. [Optional] Property root > emulators > dataconnect > host + +
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. +
+
+
+ + 5.4.3. [Optional] Property root > emulators > dataconnect > port -### emulators.eventarc.port + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+**Description:** The port that this emulator will serve on. +
+
+
+ + 5.4.4. [Optional] Property root > emulators > dataconnect > postgresHost + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### emulators.extensions +**Description:** Host for the Postgres database that backs the Data Connect emulator. +
+
- - - - - - - - - - - - - -
DescriptionPlaceholder - the Extensions emulator has no configuration options.
TypeObject
RequiredNo
+
+ + 5.4.5. [Optional] Property root > emulators > dataconnect > postgresPort + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** Port for the Postgres database that backs the Data Connect emulator. -### emulators.firestore +
+
+
+
- - - - - - - - - - - - - -
DescriptionConfig for the Firestore emulator
TypeObject
RequiredNo
+
+ + 5.5. [Optional] Property root > emulators > eventarc + +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | -### emulators.firestore.host +**Description:** Config for the EventArc emulator. +
+ + 5.5.1. [Optional] Property root > emulators > eventarc > host - - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. +
+
-### emulators.firestore.port +
+ + 5.5.2. [Optional] Property root > emulators > eventarc > port + +
- - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** The port that this emulator will serve on. +
+
+
+
-### emulators.firestore.websocketPort +
+ + 5.6. [Optional] Property root > emulators > extensions + +
- - - - - - - - - -
TypeNumber
RequiredNo
+| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** Placeholder - the Extensions emulator has no configuration options. +
+
+
+ + 5.7. [Optional] Property root > emulators > firestore + +
-### emulators.hosting +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the Firestore emulator - - - - - - - - - - - - - -
DescriptionConfig for the Firebase Hosting emulator
TypeObject
RequiredNo
+
+ + 5.7.1. [Optional] Property root > emulators > firestore > host + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### emulators.hosting.host +**Description:** The host that this emulator will serve on. +
+
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+
+ + 5.7.2. [Optional] Property root > emulators > firestore > port + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** The port that this emulator will serve on. -### emulators.hosting.port +
+
+
+ + 5.7.3. [Optional] Property root > emulators > firestore > websocketPort - - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +
+
+
+
+
+ + 5.8. [Optional] Property root > emulators > hosting -### emulators.hub + +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | - - - - - - - - - - - - - -
DescriptionConfig for the emulator suite hub.
TypeObject
RequiredNo
+**Description:** Config for the Firebase Hosting emulator +
+ + 5.8.1. [Optional] Property root > emulators > hosting > host + +
-### emulators.hub.host +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. - - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+
+
+
+ + 5.8.2. [Optional] Property root > emulators > hosting > port + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | -### emulators.hub.port +**Description:** The port that this emulator will serve on. +
+
- - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+
+
+
+ + 5.9. [Optional] Property root > emulators > hub + +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the emulator suite hub. -### emulators.logging +
+ + 5.9.1. [Optional] Property root > emulators > hub > host + +
- - - - - - - - - - - - - -
DescriptionConfig for the logging emulator.
TypeObject
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. +
+
-### emulators.logging.host +
+ + 5.9.2. [Optional] Property root > emulators > hub > port + +
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** The port that this emulator will serve on. +
+
+
+
-### emulators.logging.port +
+ + 5.10. [Optional] Property root > emulators > logging + +
- - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the logging emulator. +
+ + 5.10.1. [Optional] Property root > emulators > logging > host + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### emulators.pubsub +**Description:** The host that this emulator will serve on. +
+
- - - - - - - - - - - - - -
DescriptionConfig for the Pub/Sub emulator
TypeObject
RequiredNo
+
+ + 5.10.2. [Optional] Property root > emulators > logging > port + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | -### emulators.pubsub.host +**Description:** The port that this emulator will serve on. +
+
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+
+
+
+ + 5.11. [Optional] Property root > emulators > pubsub + +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | -### emulators.pubsub.port +**Description:** Config for the Pub/Sub emulator +
+ + 5.11.1. [Optional] Property root > emulators > pubsub > host - - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. +
+
+
+ + 5.11.2. [Optional] Property root > emulators > pubsub > port -### emulators.singleProjectMode + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionIf true, the Emulator Suite will only allow a single project to be used at a time.
TypeBoolean
RequiredNo
+**Description:** The port that this emulator will serve on. +
+
+
+
+
+ + 5.12. [Optional] Property root > emulators > singleProjectMode -### emulators.storage + +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionConfig for the Firebase Storage emulator
TypeObject
RequiredNo
+**Description:** If true, the Emulator Suite will only allow a single project to be used at a time. +
+
+
+ + 5.13. [Optional] Property root > emulators > storage -### emulators.storage.host + +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | - - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+**Description:** Config for the Firebase Storage emulator +
+ + 5.13.1. [Optional] Property root > emulators > storage > host + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### emulators.storage.port +**Description:** The host that this emulator will serve on. +
+
- - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+
+ + 5.13.2. [Optional] Property root > emulators > storage > port + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** The port that this emulator will serve on. +
+
-### emulators.tasks +
+
+
+ + 5.14. [Optional] Property root > emulators > tasks - - - - - - - - - - - - - -
DescriptionConfig for the Cloud Tasks emulator.
TypeObject
RequiredNo
+ +
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the Cloud Tasks emulator. -### emulators.tasks.host +
+ + 5.14.1. [Optional] Property root > emulators > tasks > host + +
- - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. +
+
+
+ + 5.14.2. [Optional] Property root > emulators > tasks > port -### emulators.tasks.port + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | - - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+**Description:** The port that this emulator will serve on. +
+
+
+
+
+ + 5.15. [Optional] Property root > emulators > ui + +
-### emulators.ui +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +**Description:** Config for the Emulator UI. - - - - - - - - - - - - - -
DescriptionConfig for the Emulator UI.
TypeObject
RequiredNo
+
+ + 5.15.1. [Optional] Property root > emulators > ui > enabled + +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | -### emulators.ui.enabled +**Description:** If false, the Emulator UI will not be served. +
+
- - - - - - - - - - - - - -
DescriptionIf false, the Emulator UI will not be served.
TypeBoolean
RequiredNo
+
+ + 5.15.2. [Optional] Property root > emulators > ui > host + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The host that this emulator will serve on. -### emulators.ui.host +
+
+
+ + 5.15.3. [Optional] Property root > emulators > ui > port - - - - - - - - - - - - - -
DescriptionThe host that this emulator will serve on.
TypeString
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** The port that this emulator will serve on. +
+
-### emulators.ui.port +
+
+
+
- - - - - - - - - - - - - -
DescriptionThe port that this emulator will serve on.
TypeNumber
RequiredNo
+
+ + 6. [Optional] Property root > extensions + +
+| | | +| ------------------------- | ------------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/ExtensionsConfig | +**Description:** The Firebase Extension(s) that should be deployed or emulated. +
+
+
+ + 7. [Optional] Property root > firestore -## extensions + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | - - - - - - - - - - - - - -
DescriptionThe Firebase Extension(s) that should be deployed or emulated.
TypeObject
RequiredNo
+**Description:** The Firestore rules and indexes that should be deployed or emulated. +
+| Any of(Option) | +| -------------------------------------- | +| [FirestoreSingle](#firestore_anyOf_i0) | +| [item 1](#firestore_anyOf_i1) | +
-## firestore +### 7.1. Property `root > firestore > anyOf > FirestoreSingle` +| | | +| ------------------------- | ----------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/FirestoreSingle | - - - - - - - - - - - - - -
DescriptionThe Firestore rules and indexes that should be deployed or emulated.
TypeAny of:Object
Array
RequiredNo
+**Description:** Deployment options for a single Firestore database. +
+ + 7.1.1. [Optional] Property root > firestore > anyOf > item 0 > database + +
-### firestore.0 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The id of the Firestore database to deploy. If omitted, defaults to '(default)' - - - - - - - - - -
DescriptionDeployment options for a single Firestore database.
TypeObject
+
+
+
+ + 7.1.2. [Optional] Property root > firestore > anyOf > item 0 > indexes + +
-### firestore.0.database +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Path to the firestore indexes file - - - - - - - - - -
DescriptionThe id of the Firestore database to deploy. If omitted, defaults to '(default)'
TypeString
+
+
+
+ + 7.1.3. [Optional] Property root > firestore > anyOf > item 0 > location + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### firestore.0.indexes +**Description:** The region of the Firestore database to deploy. Required when 'database' is set. +
+
- - - - - - - - - -
DescriptionPath to the firestore indexes file
TypeString
+
+ + 7.1.4. [Optional] Property root > firestore > anyOf > item 0 > postdeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. -### firestore.0.location +
+| Any of(Option) | +| ------------------------------------------------- | +| [item 0](#firestore_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#firestore_anyOf_i0_postdeploy_anyOf_i1) | - - - - - - - - - -
DescriptionThe region of the Firestore database to deploy. Required when 'database' is set.
TypeString
+
+##### 7.1.4.1. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### firestore.0.postdeploy +| Each item of this array must be | Description | +| ------------------------------------------------------------- | ----------- | +| [item 0 items](#firestore_anyOf_i0_postdeploy_anyOf_i0_items) | - | +###### 7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items - - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+##### 7.1.4.2. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 1` -### firestore.0.postdeploy.0 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
- - - - - -
TypeArray
+
+
+
+
+ + 7.1.5. [Optional] Property root > firestore > anyOf > item 0 > predeploy + +
-### firestore.0.postdeploy.1 +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. - - - - - -
TypeString
+
+| Any of(Option) | +| ------------------------------------------------ | +| [item 0](#firestore_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#firestore_anyOf_i0_predeploy_anyOf_i1) | +
+##### 7.1.5.1. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -### firestore.0.predeploy +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------------------ | ----------- | +| [item 0 items](#firestore_anyOf_i0_predeploy_anyOf_i0_items) | - | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+###### 7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### firestore.0.predeploy.0 +##### 7.1.5.2. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeArray
+
+
+
+
+
+ + 7.1.6. [Optional] Property root > firestore > anyOf > item 0 > rules -### firestore.0.predeploy.1 + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeString
+**Description:** Path to the firestore rules file +
+
+
+
+### 7.2. Property `root > firestore > anyOf > item 1` +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | -### firestore.0.rules +**Description:** Deployment options for a list of Firestore databases. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - - - - - -
DescriptionPath to the firestore rules file
TypeString
+| Each item of this array must be | Description | +| ----------------------------------------- | ----------- | +| [item 1 items](#firestore_anyOf_i1_items) | - | +#### 7.2.1. root > firestore > anyOf > item 1 > item 1 items +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +
+| Any of(Option) | +| -------------------------------------------- | +| [item 0](#firestore_anyOf_i1_items_anyOf_i0) | +| [item 1](#firestore_anyOf_i1_items_anyOf_i1) | -### firestore.1 +
+##### 7.2.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0` - - - - - - - - - -
DescriptionDeployment options for a list of Firestore databases.
TypeArray
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 7.2.1.1.1. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. -## functions +
+
+
+ + 7.2.1.1.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes - - - - - - - - - - - - - -
DescriptionThe Cloud Functions for Firebase that should be deployed or emulated.
TypeAny of:Object
Array
RequiredNo
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Path to the firestore indexes file for this database -### functions.0 +
+
+
+ + 7.2.1.1.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy - - - - - -
TypeObject
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. -### functions.0.codebase +
+| Any of(Option) | +| ---------------------------------------------------------------- | +| [item 0](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | - - - - - - - - - -
DescriptionThe codebase that these functions are part of. You can use codebases to control which functions are deployed - ie: `firebase deploy --only functions:my-codebase`
TypeString
+
+###### 7.2.1.1.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### functions.0.ignore +| Each item of this array must be | Description | +| ---------------------------------------------------------------------------- | ----------- | +| [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | +###### 7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items - - - - - - - - - -
DescriptionFiles in the source directory that should not be uploaed during dpeloyment.
TypeArray
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+###### 7.2.1.1.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### functions.0.postdeploy +
+
- - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+
+
+
+ + 7.2.1.1.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy + +
-### functions.0.postdeploy.0 +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. - - - - - -
TypeArray
+
+| Any of(Option) | +| --------------------------------------------------------------- | +| [item 0](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | +
+###### 7.2.1.1.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` -### functions.0.postdeploy.1 +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - -
TypeString
+| Each item of this array must be | Description | +| --------------------------------------------------------------------------- | ----------- | +| [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | +###### 7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+###### 7.2.1.1.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` -### functions.0.predeploy +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
- - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+
+
+
+
+ + 7.2.1.1.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules -### functions.0.predeploy.0 + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeArray
+**Description:** Path to the firestore rules file for this database +
+
+
+ + 7.2.1.1.6. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target + +
-### functions.0.predeploy.1 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The deploy target these rules and indexes should be deployed to. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. - - - - - -
TypeString
+
+
+
+
+##### 7.2.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1` +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 7.2.1.2.1. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database -### functions.0.runtime + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - - - - - - - - -
DescriptionThe runtime these functions should use.
TypeString
Enum
  • nodejs20
  • nodejs22
  • python310
  • python311
  • python312
  • python313
+**Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. +
+
+
+ + 7.2.1.2.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes + +
-### functions.0.source +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Path to the firestore indexes file for this database - - - - - - - - - -
DescriptionThe directory containing your functions source code. -This directory will be archived and uploaded during deployment. -Files outside of this directory will not be included and should not be referenced from your functions code.
TypeString
+
+
+ +
+ + 7.2.1.2.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** A script or list of scripts that will be ran after this product is deployed. + +
+ +| Any of(Option) | +| ---------------------------------------------------------------- | +| [item 0](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | +| [item 1](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | + +
+ +###### 7.2.1.2.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` + +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ---------------------------------------------------------------------------- | ----------- | +| [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | + +###### 7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +###### 7.2.1.2.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+ +
+ +
+
+ +
+ + 7.2.1.2.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** A script or list of scripts that will be ran before this product is deployed. + +
+ +| Any of(Option) | +| --------------------------------------------------------------- | +| [item 0](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | +| [item 1](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | + +
+ +###### 7.2.1.2.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` + +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| --------------------------------------------------------------------------- | ----------- | +| [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | + +###### 7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+###### 7.2.1.2.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### functions.1 +
+
- - - - - -
TypeArray
+
+
+
+ + 7.2.1.2.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules + +
-### functions.1.codebase +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Path to the firestore rules file for this database - - - - - - - - - -
DescriptionThe codebase that these functions are part of. You can use codebases to control which functions are deployed - ie: `firebase deploy --only functions:my-codebase`
TypeString
+
+
+
+ + 7.2.1.2.6. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### functions.1.ignore +**Description:** The deploy target these rules and indexes should be deployed to. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. +
+
- - - - - - - - - -
DescriptionFiles in the source directory that should not be uploaed during dpeloyment.
TypeArray
+
+
+
+
-### functions.1.postdeploy +
+
+
+ + 8. [Optional] Property root > functions - - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** The Cloud Functions for Firebase that should be deployed or emulated. -### functions.1.postdeploy.0 +
+| Any of(Option) | +| ------------------------------------- | +| [FunctionConfig](#functions_anyOf_i0) | +| [item 1](#functions_anyOf_i1) | - - - - - -
TypeArray
+
+### 8.1. Property `root > functions > anyOf > FunctionConfig` +| | | +| ------------------------- | ---------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/FunctionConfig | +
+ + 8.1.1. [Optional] Property root > functions > anyOf > item 0 > codebase -### functions.1.postdeploy.1 + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeString
+**Description:** The codebase that these functions are part of. You can use codebases to control which functions are deployed + ie: `firebase deploy --only functions:my-codebase` +
+
+
+ + 8.1.2. [Optional] Property root > functions > anyOf > item 0 > ignore + +
+| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -### functions.1.predeploy +**Description:** Files in the source directory that should not be uploaed during dpeloyment. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+| Each item of this array must be | Description | +| ------------------------------------------------ | ----------- | +| [ignore items](#functions_anyOf_i0_ignore_items) | - | +##### 8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### functions.1.predeploy.0 +
+
+
+ + 8.1.3. [Optional] Property root > functions > anyOf > item 0 > postdeploy - - - - - -
TypeArray
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. +
-### functions.1.predeploy.1 +| Any of(Option) | +| ------------------------------------------------- | +| [item 0](#functions_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#functions_anyOf_i0_postdeploy_anyOf_i1) | +
- - - - - -
TypeString
+##### 8.1.3.1. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------------------- | ----------- | +| [item 0 items](#functions_anyOf_i0_postdeploy_anyOf_i0_items) | - | +###### 8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items -### functions.1.runtime +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
- - - - - - - - - - - - -
DescriptionThe runtime these functions should use.
TypeString
Enum
  • nodejs20
  • nodejs22
  • python310
  • python311
  • python312
  • python313
+##### 8.1.3.2. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### functions.1.source +
+
+
+ + 8.1.4. [Optional] Property root > functions > anyOf > item 0 > predeploy - - - - - - - - - -
DescriptionThe directory containing your functions source code. + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** A script or list of scripts that will be ran before this product is deployed. + +
+ +| Any of(Option) | +| ------------------------------------------------ | +| [item 0](#functions_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#functions_anyOf_i0_predeploy_anyOf_i1) | + +
+ +##### 8.1.4.1. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 0` + +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------ | ----------- | +| [item 0 items](#functions_anyOf_i0_predeploy_anyOf_i0_items) | - | + +###### 8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +##### 8.1.4.2. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 1` + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+ +
+ +
+ + +
+ + 8.1.5. [Optional] Property root > functions > anyOf > item 0 > runtime + + +
+ +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | + +**Description:** The runtime these functions should use. + +Must be one of: +* "nodejs20" +* "nodejs22" +* "python310" +* "python311" +* "python312" +* "python313" + +
+
+ +
+ + 8.1.6. [Optional] Property root > functions > anyOf > item 0 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** The directory containing your functions source code. This directory will be archived and uploaded during deployment. -Files outside of this directory will not be included and should not be referenced from your functions code.
TypeString
+Files outside of this directory will not be included and should not be referenced from your functions code. + +
+
+ + +
+ +### 8.2. Property `root > functions > anyOf > item 1` + +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------- | ----------- | +| [FunctionConfig](#functions_anyOf_i1_items) | - | + +#### 8.2.1. root > functions > anyOf > item 1 > FunctionConfig + +| | | +| ------------------------- | ----------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [functions_anyOf_i0](#functions_anyOf_i0) | + +
+ + + + + + +
+ + 9. [Optional] Property root > hosting + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** The Firebase Hosting site(s) that should be deployed or emulated. + +
+ +| Any of(Option) | +| ---------------------------------- | +| [HostingSingle](#hosting_anyOf_i0) | +| [item 1](#hosting_anyOf_i1) | + +
+ +### 9.1. Property `root > hosting > anyOf > HostingSingle` + +| | | +| ------------------------- | --------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/HostingSingle | + +**Description:** Deployment options for a single Firebase Hosting site. + +
+ + 9.1.1. [Optional] Property root > hosting > anyOf > item 0 > appAssociation + + +
+ +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | + +Must be one of: +* "AUTO" +* "NONE" + +
+
+ +
+ + 9.1.2. [Optional] Property root > hosting > anyOf > item 0 > cleanUrls + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +
+
+ +
+ + 9.1.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend + + +
+ +| | | +| ------------------------- | -------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/FrameworksBackendOptions | + +**Description:** Options for this sites web frameworks backend. + +
+ + 9.1.3.1. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > concurrency + + +
+ +| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | + +**Description:** Number of requests a function can serve at once. + +
+
+ +
+ + 9.1.3.2. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cors + + +
+ +| | | +| ------------ | ------------------- | +| **Type** | `string or boolean` | +| **Required** | No | + +**Description:** If true, allows CORS on requests to this function. +If this is a `string` or `RegExp`, allows requests from domains that match the provided value. +If this is an `Array`, allows requests from domains matching at least one entry of the array. +Defaults to true for {@link https.CallableFunction} and false otherwise. + +
+
+ +
+ + 9.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cpu + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** Fractional number of CPUs to allocate to a function. + +
+ +| Any of(Option) | +| ---------------------------------------------------------- | +| [item 0](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i0) | +| [item 1](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i1) | + +
+ +###### 9.1.3.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 0` + +| | | +| ------------ | ------- | +| **Type** | `const` | +| **Required** | No | + +Specific value: `"gcf_gen1"` + +
+
+ +###### 9.1.3.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 1` + +| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | + +
+ +
+ +
+
+ +
+ + 9.1.3.4. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** Determines whether Firebase AppCheck is enforced. Defaults to false. + +
+
+ +
+ + 9.1.3.5. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings + + +
+ +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | + +**Description:** Ingress settings which control where this function can be called from. +Must be one of: +* "ALLOW_ALL" +* "ALLOW_INTERNAL_AND_GCLB" +* "ALLOW_INTERNAL_ONLY" +
+
+
+ + 9.1.3.6. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > invoker + +
+| | | +| ------------ | ------- | +| **Type** | `const` | +| **Required** | No | -## hosting +**Description:** Invoker to set access control on https functions. +Specific value: `"public"` - - - - - - - - - - - - - -
DescriptionThe Firebase Hosting site(s) that should be deployed or emulated.
TypeAny of:Object
Array
RequiredNo
+
+
+
+ + 9.1.3.7. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > labels + +
-### hosting.0 +| | | +| ------------------------- | ----------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/Record | +**Description:** User labels to set on the function. - - - - - - - - - -
DescriptionDeployment options for a single Firebase Hosting site.
TypeObject
+
+
+
+ + 9.1.3.8. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > maxInstances + +
-### hosting.0.appAssociation +| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** Max number of instances to be running in parallel. - - - - - - - - -
TypeString
Enum
  • AUTO
  • NONE
+
+
+
+ + 9.1.3.9. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > memory + +
+| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | -### hosting.0.cleanUrls +**Description:** Amount of memory to allocate to a function. +Must be one of: +* "128MiB" +* "16GiB" +* "1GiB" +* "256MiB" +* "2GiB" +* "32GiB" +* "4GiB" +* "512MiB" +* "8GiB" - - - - - -
TypeBoolean
+
+
+
+ + 9.1.3.10. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > minInstances + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | -### hosting.0.frameworksBackend +**Description:** Min number of actual instances to be running at a given time. +
+
- - - - - - - - - -
DescriptionOptions for this sites web frameworks backend.
TypeObject
+
+ + 9.1.3.11. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > omit + +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | -### hosting.0.frameworksBackend.concurrency +**Description:** If true, do not deploy or emulate this function. +
+
- - - - - - - - - -
DescriptionNumber of requests a function can serve at once.
TypeNumber
+
+ + 9.1.3.12. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges + +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | +**Description:** Controls whether function configuration modified outside of function source is preserved. Defaults to false. -### hosting.0.frameworksBackend.cors +
+
+
+ + 9.1.3.13. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > region - - - - - - - - - -
DescriptionIf true, allows CORS on requests to this function. -If this is a `string` or `RegExp`, allows requests from domains that match the provided value. -If this is an `Array`, allows requests from domains matching at least one entry of the array. -Defaults to true for {@link https.CallableFunction} and false otherwise.
Type[string, boolean]
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** HTTP functions can override global options and can specify multiple regions to deploy to. +
+
-### hosting.0.frameworksBackend.cpu +
+ + 9.1.3.14. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > secrets + +
- - - - - - - - - -
DescriptionFractional number of CPUs to allocate to a function.
TypeAny of:String
Number
+| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +**Description:** A list of secrets used in this app. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### hosting.0.frameworksBackend.cpu.0 +| Each item of this array must be | Description | +| ------------------------------------------------------------------ | ----------- | +| [secrets items](#hosting_anyOf_i0_frameworksBackend_secrets_items) | - | +###### 9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items - - - - - - - - -
TypeString
Constgcf_gen1
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+
+ + 9.1.3.15. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount + +
-### hosting.0.frameworksBackend.cpu.1 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Specific service account for the function to run as. - - - - - -
TypeNumber
+
+
+
+ + 9.1.3.16. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds + +
+| | | +| ------------ | -------- | +| **Type** | `number` | +| **Required** | No | +**Description:** Timeout for the function in seconds, possible values are 0 to 540. +HTTPS functions can specify a higher timeout. -### hosting.0.frameworksBackend.enforceAppCheck +
+
+
+ + 9.1.3.17. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector - - - - - - - - - -
DescriptionDetermines whether Firebase AppCheck is enforced. Defaults to false.
TypeBoolean
+ +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** Connect cloud function to specified VPC connector. +
+
-### hosting.0.frameworksBackend.ingressSettings +
+ + 9.1.3.18. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings + +
- - - - - - - - - - - - -
DescriptionIngress settings which control where this function can be called from.
TypeString
Enum
  • ALLOW_ALL
  • ALLOW_INTERNAL_AND_GCLB
  • ALLOW_INTERNAL_ONLY
+| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | +**Description:** Egress settings for VPC connector. +Must be one of: +* "ALL_TRAFFIC" +* "PRIVATE_RANGES_ONLY" +
+
-### hosting.0.frameworksBackend.invoker +
+
+
+ + 9.1.4. [Optional] Property root > hosting > anyOf > item 0 > headers - - - - - - - - - - - - -
DescriptionInvoker to set access control on https functions.
TypeString
Constpublic
+ +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +**Description:** A list of extra headers to send when serving specific paths on this site. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### hosting.0.frameworksBackend.labels +| Each item of this array must be | Description | +| ------------------------------------------------- | --------------------------------------------------------- | +| [HostingHeaders](#hosting_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | +##### 9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders - - - - - - - - - -
DescriptionUser labels to set on the function.
TypeObject
+| | | +| ------------------------- | ---------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/HostingHeaders | +**Description:** Extra headers that should be sent when serving this path. +
+| Any of(Option) | +| -------------------------------------------------- | +| [item 0](#hosting_anyOf_i0_headers_items_anyOf_i0) | +| [item 1](#hosting_anyOf_i0_headers_items_anyOf_i1) | +| [item 2](#hosting_anyOf_i0_headers_items_anyOf_i2) | -### hosting.0.frameworksBackend.maxInstances +
+###### 9.1.4.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0` - - - - - - - - - -
DescriptionMax number of instances to be running in parallel.
TypeNumber
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 9.1.4.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | -### hosting.0.frameworksBackend.memory +**Description:** A glob pattern describing the paths that this setting should apply to. +
+
- - - - - - - - - - - - -
DescriptionAmount of memory to allocate to a function.
TypeString
Enum
  • 128MiB
  • 16GiB
  • 1GiB
  • 256MiB
  • 2GiB
  • 32GiB
  • 4GiB
  • 512MiB
  • 8GiB
+
+ + 9.1.4.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers + +
+| | | +| ------------ | ----------------- | +| **Type** | `array of object` | +| **Required** | Yes | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### hosting.0.frameworksBackend.minInstances +| Each item of this array must be | Description | +| ----------------------------------------------------------------------- | ----------- | +| [headers items](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items) | - | +###### 9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items - - - - - - - - - -
DescriptionMin number of actual instances to be running at a given time.
TypeNumber
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 9.1.4.1.1.2.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | -### hosting.0.frameworksBackend.omit +**Description:** The header to set. +
+
- - - - - - - - - -
DescriptionIf true, do not deploy or emulate this function.
TypeBoolean
+
+ + 9.1.4.1.1.2.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The value to set this header to. -### hosting.0.frameworksBackend.preserveExternalChanges +
+
+
+
- - - - - - - - - -
DescriptionControls whether function configuration modified outside of function source is preserved. Defaults to false.
TypeBoolean
+
+
+###### 9.1.4.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1` +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 9.1.4.1.2.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers -### hosting.0.frameworksBackend.region + +
+| | | +| ------------ | ----------------- | +| **Type** | `array of object` | +| **Required** | Yes | - - - - - - - - - -
DescriptionHTTP functions can override global options and can specify multiple regions to deploy to.
TypeString
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ----------------------------------------------------------------------- | ----------- | +| [headers items](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items) | - | +###### 9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | -### hosting.0.frameworksBackend.secrets +
+ + 9.1.4.1.2.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key + +
- - - - - - - - - -
DescriptionA list of secrets used in this app.
TypeArray
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The header to set. +
+
+
+ + 9.1.4.1.2.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value -### hosting.0.frameworksBackend.serviceAccount + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - - - - - -
DescriptionSpecific service account for the function to run as.
TypeString
+**Description:** The value to set this header to. +
+
+
+
+
+ + 9.1.4.1.2.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source -### hosting.0.frameworksBackend.timeoutSeconds + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - - - - - -
DescriptionTimeout for the function in seconds, possible values are 0 to 540. -HTTPS functions can specify a higher timeout.
TypeNumber
+**Description:** A file path that this setting should apply to. +
+
+
+
+###### 9.1.4.1.3. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2` -### hosting.0.frameworksBackend.vpcConnector +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 9.1.4.1.3.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers - - - - - - - - - -
DescriptionConnect cloud function to specified VPC connector.
TypeString
+ +
+| | | +| ------------ | ----------------- | +| **Type** | `array of object` | +| **Required** | Yes | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ----------------------------------------------------------------------- | ----------- | +| [headers items](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items) | - | -### hosting.0.frameworksBackend.vpcConnectorEgressSettings +###### 9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | - - - - - - - - - - - - -
DescriptionEgress settings for VPC connector.
TypeString
Enum
  • ALL_TRAFFIC
  • PRIVATE_RANGES_ONLY
+
+ + 9.1.4.1.3.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The header to set. +
+
-### hosting.0.headers +
+ + 9.1.4.1.3.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value + +
- - - - - - - - - -
DescriptionA list of extra headers to send when serving specific paths on this site.
TypeArray
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The value to set this header to. +
+
+
+
-### hosting.0.i18n +
+ + 9.1.4.1.3.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex + +
- - - - - - - - - -
DescriptionInternationalization config for this site. +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A regex pattern that matches the paths that this setting should apply to. * + + + + + + + + + + + +
+ + 9.1.5. [Optional] Property root > hosting > anyOf > item 0 > i18n + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +**Description:** Internationalization config for this site. See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites -for instructions on how to enable interntionalization for your site.
TypeObject
+for instructions on how to enable interntionalization for your site. + +
+ + 9.1.5.1. [Required] Property root > hosting > anyOf > item 0 > i18n > root + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The directory containing internationalization rewrites. + +
+
+ +
+
+ +
+ + 9.1.6. [Optional] Property root > hosting > anyOf > item 0 > ignore + + +
+ +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +**Description:** A list of paths or globs within the source directory that should not be included in the uploaded archive. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ---------------------------------------------- | ----------- | +| [ignore items](#hosting_anyOf_i0_ignore_items) | - | + +##### 9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+ + 9.1.7. [Optional] Property root > hosting > anyOf > item 0 > postdeploy + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** A script or list of scripts that will be ran after this product is deployed. + +
+ +| Any of(Option) | +| ----------------------------------------------- | +| [item 0](#hosting_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#hosting_anyOf_i0_postdeploy_anyOf_i1) | + +
+ +##### 9.1.7.1. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0` + +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------- | +| [item 0 items](#hosting_anyOf_i0_postdeploy_anyOf_i0_items) | - | + +###### 9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +##### 9.1.7.2. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 1` + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+ +
+ +
+
+ +
+ + 9.1.8. [Optional] Property root > hosting > anyOf > item 0 > predeploy + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** A script or list of scripts that will be ran before this product is deployed. + +
+ +| Any of(Option) | +| ---------------------------------------------- | +| [item 0](#hosting_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#hosting_anyOf_i0_predeploy_anyOf_i1) | + +
+ +##### 9.1.8.1. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 0` + +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ---------------------------------------------------------- | ----------- | +| [item 0 items](#hosting_anyOf_i0_predeploy_anyOf_i0_items) | - | + +###### 9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +##### 9.1.8.2. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 1` + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+ +
+ +
+
+ +
+ + 9.1.9. [Optional] Property root > hosting > anyOf > item 0 > public + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** Whether this site should publically available. + +
+
+ +
+ + 9.1.10. [Optional] Property root > hosting > anyOf > item 0 > redirects + + +
+ +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +**Description:** A list of redirects for this site. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ----------------------------------------------------- | -------------------------------------------------------------------------------------- | +| [HostingRedirects](#hosting_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | + +##### 9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects + +| | | +| ------------------------- | ------------------------------ | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/HostingRedirects | + +**Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. + +
+ +| Any of(Option) | +| ---------------------------------------------------- | +| [item 0](#hosting_anyOf_i0_redirects_items_anyOf_i0) | +| [item 1](#hosting_anyOf_i0_redirects_items_anyOf_i1) | +| [item 2](#hosting_anyOf_i0_redirects_items_anyOf_i2) | + +
+ +###### 9.1.10.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.10.1.1.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The destination to redirect to. + +
+
+ +
+ + 9.1.10.1.1.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A glob pattern describing the paths that this setting should apply to. + +
+
+ +
+ + 9.1.10.1.1.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type + + +
+ +| | | +| ------------ | ------------------- | +| **Type** | `enum (of integer)` | +| **Required** | No | + +**Description:** The type of redirect. +Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) + +Must be one of: +* 301 +* 302 + +
+
+ +
+
+ +###### 9.1.10.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.10.1.2.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The destination to redirect to. + +
+
+ +
+ + 9.1.10.1.2.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A file path that this setting should apply to. + +
+
+ +
+ + 9.1.10.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type + + +
+ +| | | +| ------------ | ------------------- | +| **Type** | `enum (of integer)` | +| **Required** | No | + +**Description:** The type of redirect. +Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) + +Must be one of: +* 301 +* 302 + +
+
+ +
+
+ +###### 9.1.10.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.10.1.3.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The destination to redirect to. + +
+
+ +
+ + 9.1.10.1.3.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A regex pattern that matches the paths that this setting should apply to. * + +
+
+ +
+ + 9.1.10.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type + + +
+ +| | | +| ------------ | ------------------- | +| **Type** | `enum (of integer)` | +| **Required** | No | + +**Description:** The type of redirect. +Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) + +Must be one of: +* 301 +* 302 + +
+
+ +
+ +
+ +
+
+ +
+ + 9.1.11. [Optional] Property root > hosting > anyOf > item 0 > rewrites + + +
+ +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +**Description:** A list o rewrites for this site. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | +| [HostingRewrites](#hosting_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | + +##### 9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites + +| | | +| ------------------------- | ----------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/HostingRewrites | + +**Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. + +
+ +| Any of(Option) | +| ----------------------------------------------------- | +| [item 0](#hosting_anyOf_i0_rewrites_items_anyOf_i0) | +| [item 1](#hosting_anyOf_i0_rewrites_items_anyOf_i1) | +| [item 2](#hosting_anyOf_i0_rewrites_items_anyOf_i2) | +| [item 3](#hosting_anyOf_i0_rewrites_items_anyOf_i3) | +| [item 4](#hosting_anyOf_i0_rewrites_items_anyOf_i4) | +| [item 5](#hosting_anyOf_i0_rewrites_items_anyOf_i5) | +| [item 6](#hosting_anyOf_i0_rewrites_items_anyOf_i6) | +| [item 7](#hosting_anyOf_i0_rewrites_items_anyOf_i7) | +| [item 8](#hosting_anyOf_i0_rewrites_items_anyOf_i8) | +| [item 9](#hosting_anyOf_i0_rewrites_items_anyOf_i9) | +| [item 10](#hosting_anyOf_i0_rewrites_items_anyOf_i10) | +| [item 11](#hosting_anyOf_i0_rewrites_items_anyOf_i11) | +| [item 12](#hosting_anyOf_i0_rewrites_items_anyOf_i12) | +| [item 13](#hosting_anyOf_i0_rewrites_items_anyOf_i13) | +| [item 14](#hosting_anyOf_i0_rewrites_items_anyOf_i14) | + +
+ +###### 9.1.11.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.1.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A glob pattern describing the paths that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.2.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.2.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A glob pattern describing the paths that this setting should apply to. + +
+
+ +
+ + 9.1.11.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+
+ +###### 9.1.11.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.3.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.3.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The ID of the Cloud Function to rewrite to. + +
+
+ +
+ + 9.1.11.1.3.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. + +
+
+ +
+ + 9.1.11.1.3.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+
+ +
+ + 9.1.11.1.3.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A glob pattern describing the paths that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.4. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.4.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A glob pattern describing the paths that this setting should apply to. + +
+
+ +
+ + 9.1.11.1.4.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.4.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. + +
+
+ +
+ + 9.1.11.1.4.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+ + 9.1.11.1.4.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The ID of the Cloud Run service to rewrite to. + +
+
+ +
+
+ +
+
+ +###### 9.1.11.1.5. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.5.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.5.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A glob pattern describing the paths that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.6. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.6.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.6.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A file path that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.7. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.7.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.7.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+ + 9.1.11.1.7.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A file path that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.8. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.8.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.8.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The ID of the Cloud Function to rewrite to. + +
+
+ +
+ + 9.1.11.1.8.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. + +
+
+ +
+ + 9.1.11.1.8.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+
+ +
+ + 9.1.11.1.8.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A file path that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.9. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.9.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.9.1.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. + +
+
+ +
+ + 9.1.11.1.9.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+ + 9.1.11.1.9.1.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The ID of the Cloud Run service to rewrite to. + +
+
+ +
+
+ +
+ + 9.1.11.1.9.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A file path that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.10. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.10.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.10.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A file path that this setting should apply to. + +
+
+ +
+
+ +###### 9.1.11.1.11. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.11.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.11.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A regex pattern that matches the paths that this setting should apply to. * + +
+
+ +
+
+ +###### 9.1.11.1.12. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.12.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.12.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A regex pattern that matches the paths that this setting should apply to. * + +
+
+ +
+ + 9.1.11.1.12.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+
+ +###### 9.1.11.1.13. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.13.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.13.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The ID of the Cloud Function to rewrite to. + +
+
+ +
+ + 9.1.11.1.13.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. + +
+
+ +
+ + 9.1.11.1.13.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+
+ +
+ + 9.1.11.1.13.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A regex pattern that matches the paths that this setting should apply to. * + +
+
+ +
+
+ +###### 9.1.11.1.14. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.14.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A regex pattern that matches the paths that this setting should apply to. * + +
+
+ +
+ + 9.1.11.1.14.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.14.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +**Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. + +
+
+ +
+ + 9.1.11.1.14.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+ + 9.1.11.1.14.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The ID of the Cloud Run service to rewrite to. + +
+
+ +
+
+ +
+
+ +###### 9.1.11.1.15. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.1.11.1.15.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | Yes | + +
+
+ +
+ + 9.1.11.1.15.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** A regex pattern that matches the paths that this setting should apply to. * + +
+
+ +
+ +
+ +
+
+ +
+ + 9.1.12. [Optional] Property root > hosting > anyOf > item 0 > site + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** The site to deploy. + +
+
+ +
+ + 9.1.13. [Optional] Property root > hosting > anyOf > item 0 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. + +
+
+ +
+ + 9.1.14. [Optional] Property root > hosting > anyOf > item 0 > target + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** The deploy target to deploy. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. + +
+
+ +
+ + 9.1.15. [Optional] Property root > hosting > anyOf > item 0 > trailingSlash + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +
+
+ +
+
+ +### 9.2. Property `root > hosting > anyOf > item 1` + +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +**Description:** Deployment options for a list of Firebase Hosting sites. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| --------------------------------------- | ----------- | +| [item 1 items](#hosting_anyOf_i1_items) | - | + +#### 9.2.1. root > hosting > anyOf > item 1 > item 1 items + +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +
+ +| Any of(Option) | +| ------------------------------------------ | +| [item 0](#hosting_anyOf_i1_items_anyOf_i0) | +| [item 1](#hosting_anyOf_i1_items_anyOf_i1) | + +
+ +##### 9.2.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.2.1.1.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation + + +
+ +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | + +Must be one of: +* "AUTO" +* "NONE" + +
+
+ +
+ + 9.2.1.1.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +
+
+ +
+ + 9.2.1.1.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend + + +
+ +| | | +| ------------------------- | -------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [frameworksBackend](#hosting_anyOf_i0_frameworksBackend) | + +**Description:** Options for this sites web frameworks backend. + +
+
+ +
+ + 9.2.1.1.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers + + +
+ +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +**Description:** A list of extra headers to send when serving specific paths on this site. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ---------------------------------------------------------------- | --------------------------------------------------------- | +| [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | + +###### 9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders + +| | | +| ------------------------- | ----------------------------------------------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [hosting_anyOf_i0_headers_items](#hosting_anyOf_i0_headers_items) | + +**Description:** Extra headers that should be sent when serving this path. + +
+
+ +
+ + 9.2.1.1.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +**Description:** Internationalization config for this site. +See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites +for instructions on how to enable interntionalization for your site. + +
+ + 9.2.1.1.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The directory containing internationalization rewrites. + +
+
+ +
+
+ +
+ + 9.2.1.1.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore + + +
+ +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +**Description:** A list of paths or globs within the source directory that should not be included in the uploaded archive. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------- | ----------- | +| [ignore items](#hosting_anyOf_i1_items_anyOf_i0_ignore_items) | - | + +###### 9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +
+ + 9.2.1.1.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** A script or list of scripts that will be ran after this product is deployed. + +
+ +| Any of(Option) | +| -------------------------------------------------------------- | +| [item 0](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | + +
+ +###### 9.2.1.1.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` + +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| -------------------------------------------------------------------------- | ----------- | +| [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | + +###### 9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +###### 9.2.1.1.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+ +
+ +
+
+ +
+ + 9.2.1.1.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy + + +
+ +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | + +**Description:** A script or list of scripts that will be ran before this product is deployed. + +
+ +| Any of(Option) | +| ------------------------------------------------------------- | +| [item 0](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | + +
+ +###### 9.2.1.1.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` + +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------------------- | ----------- | +| [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | + +###### 9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ +###### 9.2.1.1.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+ +
+ +
+
+ +
+ + 9.2.1.1.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** Whether this site should publically available. + +
+
+ +
+ + 9.2.1.1.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects + + +
+ +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +**Description:** A list of redirects for this site. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | + +###### 9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects + +| | | +| ------------------------- | --------------------------------------------------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [hosting_anyOf_i0_redirects_items](#hosting_anyOf_i0_redirects_items) | + +**Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. + +
+
+ +
+ + 9.2.1.1.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites + + +
+ +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +**Description:** A list o rewrites for this site. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | + +###### 9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites + +| | | +| ------------------------- | ------------------------------------------------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [hosting_anyOf_i0_rewrites_items](#hosting_anyOf_i0_rewrites_items) | + +**Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. + +
+
+ +
+ + 9.2.1.1.12. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** The site to deploy + +
+
+ +
+ + 9.2.1.1.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +**Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. + +
+
+ +
+ + 9.2.1.1.14. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The deploy target to deploy. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. + +
+
+ +
+ + 9.2.1.1.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +
+
+ +
+
+ +##### 9.2.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1` + +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +
+ + 9.2.1.2.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation + + +
+ +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | + +Must be one of: +* "AUTO" +* "NONE" + +
+
+ +
+ + 9.2.1.2.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls + + +
+ +| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | + +
+
+ +
+ + 9.2.1.2.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend + + +
+ +| | | +| ------------------------- | -------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [frameworksBackend](#hosting_anyOf_i0_frameworksBackend) | + +**Description:** Options for this sites web frameworks backend. + +
+
+ +
+ + 9.2.1.2.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers + + +
+ +| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | + +**Description:** A list of extra headers to send when serving specific paths on this site. + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ---------------------------------------------------------------- | --------------------------------------------------------- | +| [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i1_headers_items) | Extra headers that should be sent when serving this path. | + +###### 9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders + +| | | +| ------------------------- | ----------------------------------------------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [hosting_anyOf_i0_headers_items](#hosting_anyOf_i0_headers_items) | + +**Description:** Extra headers that should be sent when serving this path. + +
+
+ +
+ + 9.2.1.2.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n + + +
+ +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | + +**Description:** Internationalization config for this site. +See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites +for instructions on how to enable interntionalization for your site. + +
+ + 9.2.1.2.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root + + +
+ +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | + +**Description:** The directory containing internationalization rewrites. + +
+
+
+
+
+ + 9.2.1.2.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore -### hosting.0.i18n.root + +
+| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | - - - - - - - - - -
DescriptionThe directory containing internationalization rewrites.
TypeString
+**Description:** A list of paths or globs within the source directory that should not be included in the uploaded archive. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------------------- | ----------- | +| [ignore items](#hosting_anyOf_i1_items_anyOf_i1_ignore_items) | - | +###### 9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### hosting.0.ignore +
+
+
+ + 9.2.1.2.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy - - - - - - - - - -
DescriptionA list of paths or globs within the source directory that should not be included in the uploaded archive.
TypeArray
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. +
-### hosting.0.postdeploy +| Any of(Option) | +| -------------------------------------------------------------- | +| [item 0](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | +| [item 1](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | +
- - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+###### 9.2.1.2.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### hosting.0.postdeploy.0 +| Each item of this array must be | Description | +| -------------------------------------------------------------------------- | ----------- | +| [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | +###### 9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items - - - - - -
TypeArray
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+###### 9.2.1.2.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### hosting.0.postdeploy.1 +
+
- - - - - -
TypeString
+
+
+
+ + 9.2.1.2.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. -### hosting.0.predeploy +
+| Any of(Option) | +| ------------------------------------------------------------- | +| [item 0](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | +| [item 1](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+
+###### 9.2.1.2.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -### hosting.0.predeploy.0 +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------------------------------- | ----------- | +| [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | - - - - - -
TypeArray
+###### 9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+###### 9.2.1.2.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` -### hosting.0.predeploy.1 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
- - - - - -
TypeString
+
+
+
+
+ + 9.2.1.2.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### hosting.0.public +**Description:** Whether this site should publically available. +
+
- - - - - - - - - -
DescriptionWhether this site should publically available.
TypeString
+
+ + 9.2.1.2.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects + +
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +**Description:** A list of redirects for this site. -### hosting.0.redirects +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i1_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | - - - - - - - - - -
DescriptionA list of redirects for this site.
TypeArray
+###### 9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects +| | | +| ------------------------- | --------------------------------------------------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [hosting_anyOf_i0_redirects_items](#hosting_anyOf_i0_redirects_items) | +**Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. +
+
-### hosting.0.rewrites +
+ + 9.2.1.2.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites + +
- - - - - - - - - -
DescriptionA list o rewrites for this site.
TypeArray
+| | | +| ------------ | ------- | +| **Type** | `array` | +| **Required** | No | +**Description:** A list o rewrites for this site. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -### hosting.0.site +###### 9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites +| | | +| ------------------------- | ------------------------------------------------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [hosting_anyOf_i0_rewrites_items](#hosting_anyOf_i0_rewrites_items) | - - - - - - - - - -
DescriptionThe site to deploy.
TypeString
+**Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. +
+
+
+ + 9.2.1.2.12. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site + +
-### hosting.0.source +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The site to deploy - - - - - - - - - -
DescriptionPath to the directory containing this site's source code. This will be archived and uploaded during deployment.
TypeString
+
+
+
+ + 9.2.1.2.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### hosting.0.target +**Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. +
+
- - - - - - - - - -
DescriptionThe deploy target to deploy. -See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.
TypeString
+
+ + 9.2.1.2.14. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The deploy target to deploy. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -### hosting.0.trailingSlash +
+
+
+ + 9.2.1.2.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash - - - - - -
TypeBoolean
+ +
+| | | +| ------------ | --------- | +| **Type** | `boolean` | +| **Required** | No | +
+
+
+
-### hosting.1 +
+
- - - - - - - - - -
DescriptionDeployment options for a list of Firebase Hosting sites.
TypeArray
+
+
+
+ + 10. [Optional] Property root > remoteconfig + +
+| | | +| ------------------------- | -------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/RemoteConfigConfig | +**Description:** The Remote Config template(s) used by this project. -## remoteconfig +
+ + 10.1. [Optional] Property root > remoteconfig > postdeploy + +
- - - - - - - - - - - - - -
DescriptionThe Remote Config template(s) used by this project.
TypeObject
RequiredNo
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | -### Properties -
NameType
postdeployAny of:Array
String
predeployAny of:Array
String
templateString
+**Description:** A script or list of scripts that will be ran after this product is deployed. +
-### remoteconfig.postdeploy +| Any of(Option) | +| ------------------------------------------- | +| [item 0](#remoteconfig_postdeploy_anyOf_i0) | +| [item 1](#remoteconfig_postdeploy_anyOf_i1) | +
- - - - - - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
RequiredNo
+#### 10.1.1. Property `root > remoteconfig > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### remoteconfig.postdeploy.0 +| Each item of this array must be | Description | +| ------------------------------------------------------- | ----------- | +| [item 0 items](#remoteconfig_postdeploy_anyOf_i0_items) | - | +##### 10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items - - - - - -
TypeArray
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+#### 10.1.2. Property `root > remoteconfig > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### remoteconfig.postdeploy.1 +
+
- - - - - -
TypeString
+
+
+
+ + 10.2. [Optional] Property root > remoteconfig > predeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. -### remoteconfig.predeploy +
+| Any of(Option) | +| ------------------------------------------ | +| [item 0](#remoteconfig_predeploy_anyOf_i0) | +| [item 1](#remoteconfig_predeploy_anyOf_i1) | - - - - - - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
RequiredNo
+
+#### 10.2.1. Property `root > remoteconfig > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -### remoteconfig.predeploy.0 +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [item 0 items](#remoteconfig_predeploy_anyOf_i0_items) | - | - - - - - -
TypeArray
+##### 10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+#### 10.2.2. Property `root > remoteconfig > predeploy > anyOf > item 1` -### remoteconfig.predeploy.1 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
- - - - - -
TypeString
+
+
+
+
+ + 10.3. [Required] Property root > remoteconfig > template + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | -### remoteconfig.template +**Description:** A path to a CJSON file containing a Remote Config template. +
+
- - - - - - - - - - - - - -
DescriptionA path to a CJSON file containing a Remote Config template.
TypeString
RequiredYes
+
+
+
+ + 11. [Optional] Property root > storage + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** The Firebase Storage rules that should be deployed or emulated. -## storage +
+| Any of(Option) | +| ---------------------------------- | +| [StorageSingle](#storage_anyOf_i0) | +| [item 1](#storage_anyOf_i1) | - - - - - - - - - - - - - -
DescriptionThe Firebase Storage rules that should be deployed or emulated.
TypeAny of:Object
Array
RequiredNo
+
+### 11.1. Property `root > storage > anyOf > StorageSingle` +| | | +| ------------------------- | --------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/StorageSingle | -### storage.0 +**Description:** Deployment options for a single Firebase storage bucket. +
+ + 11.1.1. [Optional] Property root > storage > anyOf > item 0 > postdeploy - - - - - - - - - -
DescriptionDeployment options for a single Firebase storage bucket.
TypeObject
+ +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran after this product is deployed. -### storage.0.postdeploy +
+| Any of(Option) | +| ----------------------------------------------- | +| [item 0](#storage_anyOf_i0_postdeploy_anyOf_i0) | +| [item 1](#storage_anyOf_i0_postdeploy_anyOf_i1) | - - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+
+##### 11.1.1.1. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | -### storage.0.postdeploy.0 +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------- | +| [item 0 items](#storage_anyOf_i0_postdeploy_anyOf_i0_items) | - | - - - - - -
TypeArray
+###### 11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+##### 11.1.1.2. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 1` -### storage.0.postdeploy.1 +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
- - - - - -
TypeString
+
+
+
+
+ + 11.1.2. [Optional] Property root > storage > anyOf > item 0 > predeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | -### storage.0.predeploy +**Description:** A script or list of scripts that will be ran before this product is deployed. +
- - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+| Any of(Option) | +| ---------------------------------------------- | +| [item 0](#storage_anyOf_i0_predeploy_anyOf_i0) | +| [item 1](#storage_anyOf_i0_predeploy_anyOf_i1) | +
+##### 11.1.2.1. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 0` -### storage.0.predeploy.0 +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - -
TypeArray
+| Each item of this array must be | Description | +| ---------------------------------------------------------- | ----------- | +| [item 0 items](#storage_anyOf_i0_predeploy_anyOf_i0_items) | - | +###### 11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### storage.0.predeploy.1 +##### 11.1.2.2. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeString
+
+
+
+
+
+ + 11.1.3. [Required] Property root > storage > anyOf > item 0 > rules + +
-### storage.0.rules +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** Path to the rules files for this Firebase Storage bucket. - - - - - - - - - -
DescriptionPath to the rules files for this Firebase Storage bucket.
TypeString
+
+
+
+ + 11.1.4. [Optional] Property root > storage > anyOf > item 0 > target + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### storage.0.target +**Description:** The deploy target to these Storage rules to. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. +
+
- - - - - - - - - -
DescriptionThe deploy target to these Storage rules to. -See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.
TypeString
+
+
+### 11.2. Property `root > storage > anyOf > item 1` +| | | +| ------------ | ----------------- | +| **Type** | `array of object` | +| **Required** | No | +**Description:** Deployment options for multiple Firebase storage buckets. +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | -### storage.1 +| Each item of this array must be | Description | +| --------------------------------------- | ----------- | +| [item 1 items](#storage_anyOf_i1_items) | - | +#### 11.2.1. root > storage > anyOf > item 1 > item 1 items - - - - - - - - - -
DescriptionDeployment options for multiple Firebase storage buckets.
TypeArray
+| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +
+ + 11.2.1.1. [Required] Property root > storage > anyOf > item 1 > item 1 items > bucket + +
-### storage.1.bucket +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | +**Description:** The Firebase Storage bucket that this config is for. - - - - - - - - - -
DescriptionThe Firebase Storage bucket that this config is for.
TypeString
+
+
+
+ + 11.2.1.2. [Optional] Property root > storage > anyOf > item 1 > item 1 items > postdeploy + +
+| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | -### storage.1.postdeploy +**Description:** A script or list of scripts that will be ran after this product is deployed. +
- - - - - - - - - -
DescriptionA script or list of scripts that will be ran after this product is deployed.
TypeAny of:Array
String
+| Any of(Option) | +| ----------------------------------------------------- | +| [item 0](#storage_anyOf_i1_items_postdeploy_anyOf_i0) | +| [item 1](#storage_anyOf_i1_items_postdeploy_anyOf_i1) | +
+###### 11.2.1.2.1. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0` -### storage.1.postdeploy.0 +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | - - - - - -
TypeArray
+| Each item of this array must be | Description | +| ----------------------------------------------------------------- | ----------- | +| [item 0 items](#storage_anyOf_i1_items_postdeploy_anyOf_i0_items) | - | +###### 11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
-### storage.1.postdeploy.1 +###### 11.2.1.2.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 1` +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | - - - - - -
TypeString
+
+
+
+
+
+ + 11.2.1.3. [Optional] Property root > storage > anyOf > item 1 > item 1 items > predeploy + +
-### storage.1.predeploy +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +**Description:** A script or list of scripts that will be ran before this product is deployed. - - - - - - - - - -
DescriptionA script or list of scripts that will be ran before this product is deployed.
TypeAny of:Array
String
+
+| Any of(Option) | +| ---------------------------------------------------- | +| [item 0](#storage_anyOf_i1_items_predeploy_anyOf_i0) | +| [item 1](#storage_anyOf_i1_items_predeploy_anyOf_i1) | +
-### storage.1.predeploy.0 +###### 11.2.1.3.1. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0` +| | | +| ------------ | ----------------- | +| **Type** | `array of string` | +| **Required** | No | - - - - - -
TypeArray
+| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| Each item of this array must be | Description | +| ---------------------------------------------------------------- | ----------- | +| [item 0 items](#storage_anyOf_i1_items_predeploy_anyOf_i0_items) | - | +###### 11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | -### storage.1.predeploy.1 +
+
+###### 11.2.1.3.2. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 1` - - - - - -
TypeString
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +
+
+
+
+
+ + 11.2.1.4. [Required] Property root > storage > anyOf > item 1 > item 1 items > rules -### storage.1.rules + +
+| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | Yes | - - - - - - - - - -
DescriptionPath to the rules files for this Firebase Storage bucket.
TypeString
+**Description:** Path to the rules files for this Firebase Storage bucket. +
+
+
+ + 11.2.1.5. [Optional] Property root > storage > anyOf > item 1 > item 1 items > target + +
-### storage.1.target +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | +**Description:** The deploy target to these Storage rules to. +See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. - - - - - - - - - -
DescriptionThe deploy target to these Storage rules to. -See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.
TypeString
+
+
+
+
+
+
- - - - - - - -
- -## Schema -``` -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "additionalProperties": false, - "definitions": { - "DataConnectSingle": { - "additionalProperties": false, - "description": "A single Data Connect deployment configs", - "properties": { - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "source": { - "type": "string" - } - }, - "required": [ - "source" - ], - "type": "object" - }, - "DatabaseSingle": { - "additionalProperties": false, - "description": "Deployment options for a single Realtime Database instance.", - "properties": { - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "The rules files for this Realtime Database instance.", - "type": "string" - } - }, - "required": [ - "rules" - ], - "type": "object" - }, - "ExtensionsConfig": { - "additionalProperties": false, - "description": "The Firebase Extensions that should be deployed to this project.\nThis is a map of instance ID to extension reference (/@)- ie:\n\"my-firestore-export\": \"firebase/firestore-bigquery-export@1.2.3\"\n\nVersion can also be a semver range.", - "type": "object" - }, - "FirestoreSingle": { - "additionalProperties": false, - "description": "Deployment options for a single Firestore database.", - "properties": { - "database": { - "description": "The id of the Firestore database to deploy. If omitted, defaults to '(default)'", - "type": "string" - }, - "indexes": { - "description": "Path to the firestore indexes file", - "type": "string" - }, - "location": { - "description": "The region of the Firestore database to deploy. Required when 'database' is set.", - "type": "string" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "Path to the firestore rules file", - "type": "string" - } - }, - "type": "object" - }, - "FrameworksBackendOptions": { - "additionalProperties": false, - "properties": { - "concurrency": { - "description": "Number of requests a function can serve at once.", - "type": "number" - }, - "cors": { - "description": "If true, allows CORS on requests to this function.\nIf this is a `string` or `RegExp`, allows requests from domains that match the provided value.\nIf this is an `Array`, allows requests from domains matching at least one entry of the array.\nDefaults to true for {@link https.CallableFunction} and false otherwise.", - "type": [ - "string", - "boolean" - ] - }, - "cpu": { - "anyOf": [ - { - "const": "gcf_gen1", - "type": "string" - }, - { - "type": "number" - } - ], - "description": "Fractional number of CPUs to allocate to a function." - }, - "enforceAppCheck": { - "description": "Determines whether Firebase AppCheck is enforced. Defaults to false.", - "type": "boolean" - }, - "ingressSettings": { - "description": "Ingress settings which control where this function can be called from.", - "enum": [ - "ALLOW_ALL", - "ALLOW_INTERNAL_AND_GCLB", - "ALLOW_INTERNAL_ONLY" - ], - "type": "string" - }, - "invoker": { - "const": "public", - "description": "Invoker to set access control on https functions.", - "type": "string" - }, - "labels": { - "$ref": "#/definitions/Record", - "description": "User labels to set on the function." - }, - "maxInstances": { - "description": "Max number of instances to be running in parallel.", - "type": "number" - }, - "memory": { - "description": "Amount of memory to allocate to a function.", - "enum": [ - "128MiB", - "16GiB", - "1GiB", - "256MiB", - "2GiB", - "32GiB", - "4GiB", - "512MiB", - "8GiB" - ], - "type": "string" - }, - "minInstances": { - "description": "Min number of actual instances to be running at a given time.", - "type": "number" - }, - "omit": { - "description": "If true, do not deploy or emulate this function.", - "type": "boolean" - }, - "preserveExternalChanges": { - "description": "Controls whether function configuration modified outside of function source is preserved. Defaults to false.", - "type": "boolean" - }, - "region": { - "description": "HTTP functions can override global options and can specify multiple regions to deploy to.", - "type": "string" - }, - "secrets": { - "description": "A list of secrets used in this app.", - "items": { - "type": "string" - }, - "type": "array" - }, - "serviceAccount": { - "description": "Specific service account for the function to run as.", - "type": "string" - }, - "timeoutSeconds": { - "description": "Timeout for the function in seconds, possible values are 0 to 540.\nHTTPS functions can specify a higher timeout.", - "type": "number" - }, - "vpcConnector": { - "description": "Connect cloud function to specified VPC connector.", - "type": "string" - }, - "vpcConnectorEgressSettings": { - "description": "Egress settings for VPC connector.", - "enum": [ - "ALL_TRAFFIC", - "PRIVATE_RANGES_ONLY" - ], - "type": "string" - } - }, - "type": "object" - }, - "FunctionConfig": { - "additionalProperties": false, - "properties": { - "codebase": { - "description": "The codebase that these functions are part of. You can use codebases to control which functions are deployed\n ie: `firebase deploy --only functions:my-codebase`", - "type": "string" - }, - "ignore": { - "description": "Files in the source directory that should not be uploaed during dpeloyment.", - "items": { - "type": "string" - }, - "type": "array" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "runtime": { - "description": "The runtime these functions should use.", - "enum": [ - "nodejs20", - "nodejs22", - "python310", - "python311", - "python312", - "python313" - ], - "type": "string" - }, - "source": { - "description": "The directory containing your functions source code.\nThis directory will be archived and uploaded during deployment.\nFiles outside of this directory will not be included and should not be referenced from your functions code.", - "type": "string" - } - }, - "type": "object" - }, - "HostingHeaders": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "glob": { - "description": "A glob pattern describing the paths that this setting should apply to.", - "type": "string" - }, - "headers": { - "items": { - "additionalProperties": false, - "properties": { - "key": { - "description": "The header to set.", - "type": "string" - }, - "value": { - "description": "The value to set this header to.", - "type": "string" - } - }, - "required": [ - "key", - "value" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "glob", - "headers" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "headers": { - "items": { - "additionalProperties": false, - "properties": { - "key": { - "description": "The header to set.", - "type": "string" - }, - "value": { - "description": "The value to set this header to.", - "type": "string" - } - }, - "required": [ - "key", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "source": { - "description": "A file path that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "headers", - "source" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "headers": { - "items": { - "additionalProperties": false, - "properties": { - "key": { - "description": "The header to set.", - "type": "string" - }, - "value": { - "description": "The value to set this header to.", - "type": "string" - } - }, - "required": [ - "key", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "regex": { - "description": "A regex pattern that matches the paths that this setting should apply to. *", - "type": "string" - } - }, - "required": [ - "headers", - "regex" - ], - "type": "object" - } - ], - "description": "Extra headers that should be sent when serving this path." - }, - "HostingRedirects": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "destination": { - "description": "The destination to redirect to.", - "type": "string" - }, - "glob": { - "description": "A glob pattern describing the paths that this setting should apply to.", - "type": "string" - }, - "type": { - "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", - "enum": [ - 301, - 302 - ], - "type": "number" - } - }, - "required": [ - "destination", - "glob" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "destination": { - "description": "The destination to redirect to.", - "type": "string" - }, - "source": { - "description": "A file path that this setting should apply to.", - "type": "string" - }, - "type": { - "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", - "enum": [ - 301, - 302 - ], - "type": "number" - } - }, - "required": [ - "destination", - "source" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "destination": { - "description": "The destination to redirect to.", - "type": "string" - }, - "regex": { - "description": "A regex pattern that matches the paths that this setting should apply to. *", - "type": "string" - }, - "type": { - "description": "The type of redirect.\nUse 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)", - "enum": [ - 301, - 302 - ], - "type": "number" - } - }, - "required": [ - "destination", - "regex" - ], - "type": "object" - } - ], - "description": "URL redirects for a hosting site. Use these to prevent broken links when moving pages." - }, - "HostingRewrites": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "destination": { - "type": "string" - }, - "glob": { - "description": "A glob pattern describing the paths that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "destination", - "glob" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "function": { - "type": "string" - }, - "glob": { - "description": "A glob pattern describing the paths that this setting should apply to.", - "type": "string" - }, - "region": { - "type": "string" - } - }, - "required": [ - "function", - "glob" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "function": { - "additionalProperties": false, - "properties": { - "functionId": { - "description": "The ID of the Cloud Function to rewrite to.", - "type": "string" - }, - "pinTag": { - "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", - "type": "boolean" - }, - "region": { - "type": "string" - } - }, - "required": [ - "functionId" - ], - "type": "object" - }, - "glob": { - "description": "A glob pattern describing the paths that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "function", - "glob" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "glob": { - "description": "A glob pattern describing the paths that this setting should apply to.", - "type": "string" - }, - "run": { - "additionalProperties": false, - "properties": { - "pinTag": { - "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", - "type": "boolean" - }, - "region": { - "type": "string" - }, - "serviceId": { - "description": "The ID of the Cloud Run service to rewrite to.", - "type": "string" - } - }, - "required": [ - "serviceId" - ], - "type": "object" - } - }, - "required": [ - "glob", - "run" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "dynamicLinks": { - "type": "boolean" - }, - "glob": { - "description": "A glob pattern describing the paths that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "dynamicLinks", - "glob" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "destination": { - "type": "string" - }, - "source": { - "description": "A file path that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "destination", - "source" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "function": { - "type": "string" - }, - "region": { - "type": "string" - }, - "source": { - "description": "A file path that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "function", - "source" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "function": { - "additionalProperties": false, - "properties": { - "functionId": { - "description": "The ID of the Cloud Function to rewrite to.", - "type": "string" - }, - "pinTag": { - "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", - "type": "boolean" - }, - "region": { - "type": "string" - } - }, - "required": [ - "functionId" - ], - "type": "object" - }, - "source": { - "description": "A file path that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "function", - "source" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "run": { - "additionalProperties": false, - "properties": { - "pinTag": { - "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", - "type": "boolean" - }, - "region": { - "type": "string" - }, - "serviceId": { - "description": "The ID of the Cloud Run service to rewrite to.", - "type": "string" - } - }, - "required": [ - "serviceId" - ], - "type": "object" - }, - "source": { - "description": "A file path that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "run", - "source" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "dynamicLinks": { - "type": "boolean" - }, - "source": { - "description": "A file path that this setting should apply to.", - "type": "string" - } - }, - "required": [ - "dynamicLinks", - "source" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "destination": { - "type": "string" - }, - "regex": { - "description": "A regex pattern that matches the paths that this setting should apply to. *", - "type": "string" - } - }, - "required": [ - "destination", - "regex" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "function": { - "type": "string" - }, - "regex": { - "description": "A regex pattern that matches the paths that this setting should apply to. *", - "type": "string" - }, - "region": { - "type": "string" - } - }, - "required": [ - "function", - "regex" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "function": { - "additionalProperties": false, - "properties": { - "functionId": { - "description": "The ID of the Cloud Function to rewrite to.", - "type": "string" - }, - "pinTag": { - "description": "If true, the rewrite will be pinned to the currently running version of the Cloud Function.", - "type": "boolean" - }, - "region": { - "type": "string" - } - }, - "required": [ - "functionId" - ], - "type": "object" - }, - "regex": { - "description": "A regex pattern that matches the paths that this setting should apply to. *", - "type": "string" - } - }, - "required": [ - "function", - "regex" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "regex": { - "description": "A regex pattern that matches the paths that this setting should apply to. *", - "type": "string" - }, - "run": { - "additionalProperties": false, - "properties": { - "pinTag": { - "description": "If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.", - "type": "boolean" - }, - "region": { - "type": "string" - }, - "serviceId": { - "description": "The ID of the Cloud Run service to rewrite to.", - "type": "string" - } - }, - "required": [ - "serviceId" - ], - "type": "object" - } - }, - "required": [ - "regex", - "run" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "dynamicLinks": { - "type": "boolean" - }, - "regex": { - "description": "A regex pattern that matches the paths that this setting should apply to. *", - "type": "string" - } - }, - "required": [ - "dynamicLinks", - "regex" - ], - "type": "object" - } - ], - "description": "Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service." - }, - "HostingSingle": { - "additionalProperties": false, - "description": "Deployment options for a single Firebase Hosting site.", - "properties": { - "appAssociation": { - "enum": [ - "AUTO", - "NONE" - ], - "type": "string" - }, - "cleanUrls": { - "type": "boolean" - }, - "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions", - "description": "Options for this sites web frameworks backend." - }, - "headers": { - "description": "A list of extra headers to send when serving specific paths on this site.", - "items": { - "$ref": "#/definitions/HostingHeaders" - }, - "type": "array" - }, - "i18n": { - "additionalProperties": false, - "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", - "properties": { - "root": { - "description": "The directory containing internationalization rewrites.", - "type": "string" - } - }, - "required": [ - "root" - ], - "type": "object" - }, - "ignore": { - "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", - "items": { - "type": "string" - }, - "type": "array" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "public": { - "description": "Whether this site should publically available.", - "type": "string" - }, - "redirects": { - "description": "A list of redirects for this site.", - "items": { - "$ref": "#/definitions/HostingRedirects" - }, - "type": "array" - }, - "rewrites": { - "description": "A list o rewrites for this site.", - "items": { - "$ref": "#/definitions/HostingRewrites" - }, - "type": "array" - }, - "site": { - "description": "The site to deploy.", - "type": "string" - }, - "source": { - "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", - "type": "string" - }, - "target": { - "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", - "type": "string" - }, - "trailingSlash": { - "type": "boolean" - } - }, - "type": "object" - }, - "Record": { - "additionalProperties": false, - "type": "object" - }, - "RemoteConfigConfig": { - "additionalProperties": false, - "description": "A Remote Config template to deploy.", - "properties": { - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "template": { - "description": "A path to a CJSON file containing a Remote Config template.", - "type": "string" - } - }, - "required": [ - "template" - ], - "type": "object" - }, - "StorageSingle": { - "additionalProperties": false, - "description": "Deployment options for a single Firebase storage bucket.", - "properties": { - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "Path to the rules files for this Firebase Storage bucket.", - "type": "string" - }, - "target": { - "description": "The deploy target to these Storage rules to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", - "type": "string" - } - }, - "required": [ - "rules" - ], - "type": "object" - } - }, - "description": "Information about the resources in your Firebase project.\nThis used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start`", - "properties": { - "$schema": { - "description": "Unused. Included in schema so that the schema can be applied to single files.", - "format": "uri", - "type": "string" - }, - "apphosting": { - "anyOf": [ - { - "additionalProperties": false, - "description": "A single App Hosting deployment configs", - "properties": { - "alwaysDeployFromSource": { - "description": "If true, this backend will only be deployed from local source, not from source control.", - "type": "boolean" - }, - "backendId": { - "type": "string" - }, - "ignore": { - "description": "A list of file paths to exclude from the archive that is uploaded for this backend.", - "items": { - "type": "string" - }, - "type": "array" - }, - "rootDir": { - "type": "string" - } - }, - "required": [ - "backendId", - "ignore", - "rootDir" - ], - "type": "object" - }, - { - "description": "A list of App Hosting deployment configs", - "items": { - "additionalProperties": false, - "description": "A single App Hosting deployment configs", - "properties": { - "alwaysDeployFromSource": { - "description": "If true, this backend will only be deployed from local source, not from source control.", - "type": "boolean" - }, - "backendId": { - "type": "string" - }, - "ignore": { - "description": "A list of file paths to exclude from the archive that is uploaded for this backend.", - "items": { - "type": "string" - }, - "type": "array" - }, - "rootDir": { - "type": "string" - } - }, - "required": [ - "backendId", - "ignore", - "rootDir" - ], - "type": "object" - }, - "type": "array" - } - ], - "description": "The App Hosting backend(s) that should be deployed or emulated." - }, - "database": { - "anyOf": [ - { - "$ref": "#/definitions/DatabaseSingle", - "description": "Deployment options for a single Realtime Database instance." - }, - { - "description": "Deployment options for a list of Realtime Database instancs.", - "items": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "instance": { - "description": "The instance that this rules files is for.", - "type": "string" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "The rules files for this Realtime Database instance.", - "type": "string" - }, - "target": { - "type": "string" - } - }, - "required": [ - "instance", - "rules" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "instance": { - "description": "The instance that this rules files is for.", - "type": "string" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "The rules files for this Realtime Database instance.", - "type": "string" - }, - "target": { - "type": "string" - } - }, - "required": [ - "rules", - "target" - ], - "type": "object" - } - ] - }, - "type": "array" - } - ], - "description": "The Realtime Database rules that should be deployed or emulated." - }, - "dataconnect": { - "anyOf": [ - { - "$ref": "#/definitions/DataConnectSingle", - "description": "A single Data Connect deployment configs" - }, - { - "description": "A list of Data Connect deployment configs", - "items": { - "$ref": "#/definitions/DataConnectSingle" - }, - "type": "array" - } - ], - "description": "The Data Connect service(s) that should be deployed or emulated." - }, - "emulators": { - "additionalProperties": false, - "description": "Hosts, ports, and configuration options for the Firebase Emulator suite.", - "properties": { - "apphosting": { - "additionalProperties": false, - "description": "Config for the App Hosting emulator", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - }, - "rootDirectory": { - "description": "The root directory of your app. The start command will ran from this directory.", - "type": "string" - }, - "startCommand": { - "description": "The command that will be run to start your app when emulating your App Hosting backend", - "type": "string" - }, - "startCommandOverride": { - "type": "string" - } - }, - "type": "object" - }, - "auth": { - "additionalProperties": false, - "description": "Config for the Auth emulator", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "database": { - "additionalProperties": false, - "description": "Config for the Realtime Database emulator", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "dataconnect": { - "additionalProperties": false, - "description": "Config for the Data Connect emulator.", - "properties": { - "dataDir": { - "description": "The directory to persist emulator data to. If set, data will be saved between runs automatically.\nIf the --import flag is used, the current data will be overwritten by the imported data.", - "type": "string" - }, - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - }, - "postgresHost": { - "description": "Host for the Postgres database that backs the Data Connect emulator.", - "type": "string" - }, - "postgresPort": { - "description": "Port for the Postgres database that backs the Data Connect emulator.", - "type": "number" - } - }, - "type": "object" - }, - "eventarc": { - "additionalProperties": false, - "description": "Config for the EventArc emulator.", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "extensions": { - "description": "Placeholder - the Extensions emulator has no configuration options.", - "properties": {}, - "type": "object" - }, - "firestore": { - "additionalProperties": false, - "description": "Config for the Firestore emulator", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - }, - "websocketPort": { - "type": "number" - } - }, - "type": "object" - }, - "hosting": { - "additionalProperties": false, - "description": "Config for the Firebase Hosting emulator", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "hub": { - "additionalProperties": false, - "description": "Config for the emulator suite hub.", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "logging": { - "additionalProperties": false, - "description": "Config for the logging emulator.", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "pubsub": { - "additionalProperties": false, - "description": "Config for the Pub/Sub emulator", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "singleProjectMode": { - "description": "If true, the Emulator Suite will only allow a single project to be used at a time.", - "type": "boolean" - }, - "storage": { - "additionalProperties": false, - "description": "Config for the Firebase Storage emulator", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "tasks": { - "additionalProperties": false, - "description": "Config for the Cloud Tasks emulator.", - "properties": { - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - }, - "ui": { - "additionalProperties": false, - "description": "Config for the Emulator UI.", - "properties": { - "enabled": { - "description": "If false, the Emulator UI will not be served.", - "type": "boolean" - }, - "host": { - "description": "The host that this emulator will serve on.", - "type": "string" - }, - "port": { - "description": "The port that this emulator will serve on.", - "type": "number" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "extensions": { - "$ref": "#/definitions/ExtensionsConfig", - "description": "The Firebase Extension(s) that should be deployed or emulated." - }, - "firestore": { - "anyOf": [ - { - "$ref": "#/definitions/FirestoreSingle", - "description": "Deployment options for a single Firestore database." - }, - { - "description": "Deployment options for a list of Firestore databases.", - "items": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "database": { - "description": "The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.", - "type": "string" - }, - "indexes": { - "description": "Path to the firestore indexes file for this database", - "type": "string" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "Path to the firestore rules file for this database", - "type": "string" - }, - "target": { - "description": "The deploy target these rules and indexes should be deployed to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", - "type": "string" - } - }, - "required": [ - "target" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "database": { - "description": "The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.", - "type": "string" - }, - "indexes": { - "description": "Path to the firestore indexes file for this database", - "type": "string" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "Path to the firestore rules file for this database", - "type": "string" - }, - "target": { - "description": "The deploy target these rules and indexes should be deployed to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", - "type": "string" - } - }, - "required": [ - "database" - ], - "type": "object" - } - ] - }, - "type": "array" - } - ], - "description": "The Firestore rules and indexes that should be deployed or emulated." - }, - "functions": { - "anyOf": [ - { - "$ref": "#/definitions/FunctionConfig" - }, - { - "items": { - "$ref": "#/definitions/FunctionConfig" - }, - "type": "array" - } - ], - "description": "The Cloud Functions for Firebase that should be deployed or emulated." - }, - "hosting": { - "anyOf": [ - { - "$ref": "#/definitions/HostingSingle", - "description": "Deployment options for a single Firebase Hosting site." - }, - { - "description": "Deployment options for a list of Firebase Hosting sites.", - "items": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "appAssociation": { - "enum": [ - "AUTO", - "NONE" - ], - "type": "string" - }, - "cleanUrls": { - "type": "boolean" - }, - "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions", - "description": "Options for this sites web frameworks backend." - }, - "headers": { - "description": "A list of extra headers to send when serving specific paths on this site.", - "items": { - "$ref": "#/definitions/HostingHeaders" - }, - "type": "array" - }, - "i18n": { - "additionalProperties": false, - "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", - "properties": { - "root": { - "description": "The directory containing internationalization rewrites.", - "type": "string" - } - }, - "required": [ - "root" - ], - "type": "object" - }, - "ignore": { - "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", - "items": { - "type": "string" - }, - "type": "array" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "public": { - "description": "Whether this site should publically available.", - "type": "string" - }, - "redirects": { - "description": "A list of redirects for this site.", - "items": { - "$ref": "#/definitions/HostingRedirects" - }, - "type": "array" - }, - "rewrites": { - "description": "A list o rewrites for this site.", - "items": { - "$ref": "#/definitions/HostingRewrites" - }, - "type": "array" - }, - "site": { - "description": "The site to deploy", - "type": "string" - }, - "source": { - "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", - "type": "string" - }, - "target": { - "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", - "type": "string" - }, - "trailingSlash": { - "type": "boolean" - } - }, - "required": [ - "target" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "appAssociation": { - "enum": [ - "AUTO", - "NONE" - ], - "type": "string" - }, - "cleanUrls": { - "type": "boolean" - }, - "frameworksBackend": { - "$ref": "#/definitions/FrameworksBackendOptions", - "description": "Options for this sites web frameworks backend." - }, - "headers": { - "description": "A list of extra headers to send when serving specific paths on this site.", - "items": { - "$ref": "#/definitions/HostingHeaders" - }, - "type": "array" - }, - "i18n": { - "additionalProperties": false, - "description": "Internationalization config for this site.\nSee https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites\nfor instructions on how to enable interntionalization for your site.", - "properties": { - "root": { - "description": "The directory containing internationalization rewrites.", - "type": "string" - } - }, - "required": [ - "root" - ], - "type": "object" - }, - "ignore": { - "description": "A list of paths or globs within the source directory that should not be included in the uploaded archive.", - "items": { - "type": "string" - }, - "type": "array" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "public": { - "description": "Whether this site should publically available.", - "type": "string" - }, - "redirects": { - "description": "A list of redirects for this site.", - "items": { - "$ref": "#/definitions/HostingRedirects" - }, - "type": "array" - }, - "rewrites": { - "description": "A list o rewrites for this site.", - "items": { - "$ref": "#/definitions/HostingRewrites" - }, - "type": "array" - }, - "site": { - "description": "The site to deploy", - "type": "string" - }, - "source": { - "description": "Path to the directory containing this site's source code. This will be archived and uploaded during deployment.", - "type": "string" - }, - "target": { - "description": "The deploy target to deploy.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", - "type": "string" - }, - "trailingSlash": { - "type": "boolean" - } - }, - "required": [ - "site" - ], - "type": "object" - } - ] - }, - "type": "array" - } - ], - "description": "The Firebase Hosting site(s) that should be deployed or emulated." - }, - "remoteconfig": { - "$ref": "#/definitions/RemoteConfigConfig", - "description": "The Remote Config template(s) used by this project." - }, - "storage": { - "anyOf": [ - { - "$ref": "#/definitions/StorageSingle", - "description": "Deployment options for a single Firebase storage bucket." - }, - { - "description": "Deployment options for multiple Firebase storage buckets.", - "items": { - "additionalProperties": false, - "properties": { - "bucket": { - "description": "The Firebase Storage bucket that this config is for.", - "type": "string" - }, - "postdeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran after this product is deployed." - }, - "predeploy": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "A script or list of scripts that will be ran before this product is deployed." - }, - "rules": { - "description": "Path to the rules files for this Firebase Storage bucket.", - "type": "string" - }, - "target": { - "description": "The deploy target to these Storage rules to.\nSee https://firebase.google.com/docs/cli/targets to learn more about deploy targets.", - "type": "string" - } - }, - "required": [ - "bucket", - "rules" - ], - "type": "object" - }, - "type": "array" - } - ], - "description": "The Firebase Storage rules that should be deployed or emulated." - } - }, - "type": "object" -} -``` - - +---------------------------------------------------------------------------------------------------------------------------- +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file diff --git a/schema/docs/index.md b/schema/docs/index.md deleted file mode 100644 index 16187f0d832..00000000000 --- a/schema/docs/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Index -- [connector-yaml](connector-yaml.md) -- [dataconnect-yaml](dataconnect-yaml.md) -- [extension-yaml](extension-yaml.md) -- [firebase-config](firebase-config.md) diff --git a/schema/extension-yaml.json b/schema/extension-yaml.json index 7ba7e2f99cc..a7699c2b04a 100644 --- a/schema/extension-yaml.json +++ b/schema/extension-yaml.json @@ -1,6 +1,7 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "extension.yaml", + "description": "extension.yaml declares the resources and configurable parameters for a Firebase Extension.", "additionalProperties": false, "definitions": { "author": { From 9fe35b9d793af4f5dbc09939b2008484d53b92ed Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Tue, 17 Jun 2025 07:03:28 -0700 Subject: [PATCH 06/10] Non nested MD --- schema/docs/connector-yaml.md | 297 +-- schema/docs/dataconnect-yaml.md | 167 +- schema/docs/extension-yaml.md | 1123 +++------ schema/docs/firebase-config.md | 4156 ++++++++----------------------- 4 files changed, 1450 insertions(+), 4293 deletions(-) diff --git a/schema/docs/connector-yaml.md b/schema/docs/connector-yaml.md index 2a4e006483f..e889af0c9ee 100644 --- a/schema/docs/connector-yaml.md +++ b/schema/docs/connector-yaml.md @@ -1,36 +1,36 @@ # Schema Docs -- [1. [Optional] Property root > connectorId](#connectorId) -- [2. [Optional] Property root > generate](#generate) - - [2.1. [Optional] Property root > generate > javascriptSdk](#generate_javascriptSdk) +- [1. Property `root > connectorId`](#connectorId) +- [2. Property `root > generate`](#generate) + - [2.1. Property `root > generate > javascriptSdk`](#generate_javascriptSdk) - [2.1.1. Property `root > generate > javascriptSdk > oneOf > javascriptSdk`](#generate_javascriptSdk_oneOf_i0) - - [2.1.1.1. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > outputDir](#generate_javascriptSdk_oneOf_i0_outputDir) - - [2.1.1.2. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > package](#generate_javascriptSdk_oneOf_i0_package) - - [2.1.1.3. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir](#generate_javascriptSdk_oneOf_i0_packageJSONDir) + - [2.1.1.1. Property `root > generate > javascriptSdk > oneOf > item 0 > outputDir`](#generate_javascriptSdk_oneOf_i0_outputDir) + - [2.1.1.2. Property `root > generate > javascriptSdk > oneOf > item 0 > package`](#generate_javascriptSdk_oneOf_i0_package) + - [2.1.1.3. Property `root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir`](#generate_javascriptSdk_oneOf_i0_packageJSONDir) - [2.1.2. Property `root > generate > javascriptSdk > oneOf > item 1`](#generate_javascriptSdk_oneOf_i1) - - [2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk](#autogenerated_heading_2) - - [2.2. [Optional] Property root > generate > dartSdk](#generate_dartSdk) + - [2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk](#generate_javascriptSdk_oneOf_i1_items) + - [2.2. Property `root > generate > dartSdk`](#generate_dartSdk) - [2.2.1. Property `root > generate > dartSdk > oneOf > dartSdk`](#generate_dartSdk_oneOf_i0) - - [2.2.1.1. [Optional] Property root > generate > dartSdk > oneOf > item 0 > outputDir](#generate_dartSdk_oneOf_i0_outputDir) - - [2.2.1.2. [Optional] Property root > generate > dartSdk > oneOf > item 0 > package](#generate_dartSdk_oneOf_i0_package) + - [2.2.1.1. Property `root > generate > dartSdk > oneOf > item 0 > outputDir`](#generate_dartSdk_oneOf_i0_outputDir) + - [2.2.1.2. Property `root > generate > dartSdk > oneOf > item 0 > package`](#generate_dartSdk_oneOf_i0_package) - [2.2.2. Property `root > generate > dartSdk > oneOf > item 1`](#generate_dartSdk_oneOf_i1) - - [2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk](#autogenerated_heading_3) - - [2.3. [Optional] Property root > generate > kotlinSdk](#generate_kotlinSdk) + - [2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk](#generate_dartSdk_oneOf_i1_items) + - [2.3. Property `root > generate > kotlinSdk`](#generate_kotlinSdk) - [2.3.1. Property `root > generate > kotlinSdk > oneOf > kotlinSdk`](#generate_kotlinSdk_oneOf_i0) - - [2.3.1.1. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > outputDir](#generate_kotlinSdk_oneOf_i0_outputDir) - - [2.3.1.2. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > package](#generate_kotlinSdk_oneOf_i0_package) + - [2.3.1.1. Property `root > generate > kotlinSdk > oneOf > item 0 > outputDir`](#generate_kotlinSdk_oneOf_i0_outputDir) + - [2.3.1.2. Property `root > generate > kotlinSdk > oneOf > item 0 > package`](#generate_kotlinSdk_oneOf_i0_package) - [2.3.2. Property `root > generate > kotlinSdk > oneOf > item 1`](#generate_kotlinSdk_oneOf_i1) - - [2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk](#autogenerated_heading_4) - - [2.4. [Optional] Property root > generate > swiftSdk](#generate_swiftSdk) + - [2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk](#generate_kotlinSdk_oneOf_i1_items) + - [2.4. Property `root > generate > swiftSdk`](#generate_swiftSdk) - [2.4.1. Property `root > generate > swiftSdk > oneOf > swiftSdk`](#generate_swiftSdk_oneOf_i0) - - [2.4.1.1. [Optional] Property root > generate > swiftSdk > oneOf > item 0 > outputDir](#generate_swiftSdk_oneOf_i0_outputDir) + - [2.4.1.1. Property `root > generate > swiftSdk > oneOf > item 0 > outputDir`](#generate_swiftSdk_oneOf_i0_outputDir) - [2.4.2. Property `root > generate > swiftSdk > oneOf > item 1`](#generate_swiftSdk_oneOf_i1) - - [2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk](#autogenerated_heading_5) - - [2.5. [Optional] Property root > generate > llmTools](#generate_llmTools) + - [2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk](#generate_swiftSdk_oneOf_i1_items) + - [2.5. Property `root > generate > llmTools`](#generate_llmTools) - [2.5.1. Property `root > generate > llmTools > oneOf > llmTools`](#generate_llmTools_oneOf_i0) - - [2.5.1.1. [Optional] Property root > generate > llmTools > oneOf > item 0 > outputFile](#generate_llmTools_oneOf_i0_outputFile) + - [2.5.1.1. Property `root > generate > llmTools > oneOf > item 0 > outputFile`](#generate_llmTools_oneOf_i0_outputFile) - [2.5.2. Property `root > generate > llmTools > oneOf > item 1`](#generate_llmTools_oneOf_i1) - - [2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools](#autogenerated_heading_6) + - [2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools](#generate_llmTools_oneOf_i1_items) | | | | ------------------------- | ----------- | @@ -40,12 +40,12 @@ **Description:** connector.yaml is how you configure a connector for your Firebase Data Connect service. -
- - 1. [Optional] Property root > connectorId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------ | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| - [connectorId](#connectorId ) | No | string | No | - | The ID of the Firebase Data Connect connector. | +| - [generate](#generate ) | No | object | No | - | - | - -
+## 1. Property `root > connectorId` | | | | ------------ | -------- | @@ -54,15 +54,7 @@ **Description:** The ID of the Firebase Data Connect connector. -
-
- -
- - 2. [Optional] Property root > generate - - -
+## 2. Property `root > generate` | | | | ------------------------- | ----------- | @@ -70,12 +62,15 @@ | **Required** | No | | **Additional properties** | Not allowed | -
- - 2.1. [Optional] Property root > generate > javascriptSdk +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------- | +| - [javascriptSdk](#generate_javascriptSdk ) | No | Combination | No | - | Configuration for a generated Javascript SDK | +| - [dartSdk](#generate_dartSdk ) | No | Combination | No | - | Configuration for a generated Dart SDK | +| - [kotlinSdk](#generate_kotlinSdk ) | No | Combination | No | - | Configuration for a generated Kotlin SDK | +| - [swiftSdk](#generate_swiftSdk ) | No | Combination | No | - | Configuration for a generated Swift SDK | +| - [llmTools](#generate_llmTools ) | No | Combination | No | - | - | - -
+### 2.1. Property `root > generate > javascriptSdk` | | | | ------------------------- | ---------------- | @@ -85,15 +80,11 @@ **Description:** Configuration for a generated Javascript SDK -
- | One of(Option) | | ------------------------------------------------- | | [javascriptSdk](#generate_javascriptSdk_oneOf_i0) | | [item 1](#generate_javascriptSdk_oneOf_i1) | -
- #### 2.1.1. Property `root > generate > javascriptSdk > oneOf > javascriptSdk` | | | @@ -103,12 +94,14 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/javascriptSdk | -
- - 2.1.1.1. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------- | +| - [outputDir](#generate_javascriptSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [package](#generate_javascriptSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | +| - [packageJSONDir](#generate_javascriptSdk_oneOf_i0_packageJSONDir ) | No | string | No | - | The directory containining the package.json to install the generated package in. | +| - [](#generate_javascriptSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.1.1.1. Property `root > generate > javascriptSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -117,15 +110,7 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
- - 2.1.1.2. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > package - - -
+##### 2.1.1.2. Property `root > generate > javascriptSdk > oneOf > item 0 > package` | | | | ------------ | -------- | @@ -134,15 +119,7 @@ **Description:** The package name to use for the generated code. -
-
- -
- - 2.1.1.3. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir - - -
+##### 2.1.1.3. Property `root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir` | | | | ------------ | -------- | @@ -151,12 +128,6 @@ **Description:** The directory containining the package.json to install the generated package in. -
-
- -
-
- #### 2.1.2. Property `root > generate > javascriptSdk > oneOf > item 1` | | | @@ -176,7 +147,7 @@ | ------------------------------------------------------- | ----------- | | [javascriptSdk](#generate_javascriptSdk_oneOf_i1_items) | - | -##### 2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk +##### 2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk | | | | ------------------------- | ------------------------------------------------------------------- | @@ -185,19 +156,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_javascriptSdk_oneOf_i0](#generate_javascriptSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.2. [Optional] Property root > generate > dartSdk - - -
+### 2.2. Property `root > generate > dartSdk` | | | | ------------------------- | ---------------- | @@ -207,15 +166,11 @@ **Description:** Configuration for a generated Dart SDK -
- | One of(Option) | | ------------------------------------- | | [dartSdk](#generate_dartSdk_oneOf_i0) | | [item 1](#generate_dartSdk_oneOf_i1) | -
- #### 2.2.1. Property `root > generate > dartSdk > oneOf > dartSdk` | | | @@ -225,12 +180,13 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/dartSdk | -
- - 2.2.1.1. [Optional] Property root > generate > dartSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | +| - [outputDir](#generate_dartSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [package](#generate_dartSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | +| - [](#generate_dartSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.2.1.1. Property `root > generate > dartSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -239,15 +195,7 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
- - 2.2.1.2. [Optional] Property root > generate > dartSdk > oneOf > item 0 > package - - -
+##### 2.2.1.2. Property `root > generate > dartSdk > oneOf > item 0 > package` | | | | ------------ | -------- | @@ -256,12 +204,6 @@ **Description:** The package name to use for the generated code. -
-
- -
-
- #### 2.2.2. Property `root > generate > dartSdk > oneOf > item 1` | | | @@ -281,7 +223,7 @@ | ------------------------------------------- | ----------- | | [dartSdk](#generate_dartSdk_oneOf_i1_items) | - | -##### 2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk +##### 2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk | | | | ------------------------- | ------------------------------------------------------- | @@ -290,19 +232,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_dartSdk_oneOf_i0](#generate_dartSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.3. [Optional] Property root > generate > kotlinSdk - - -
+### 2.3. Property `root > generate > kotlinSdk` | | | | ------------------------- | ---------------- | @@ -312,15 +242,11 @@ **Description:** Configuration for a generated Kotlin SDK -
- | One of(Option) | | ----------------------------------------- | | [kotlinSdk](#generate_kotlinSdk_oneOf_i0) | | [item 1](#generate_kotlinSdk_oneOf_i1) | -
- #### 2.3.1. Property `root > generate > kotlinSdk > oneOf > kotlinSdk` | | | @@ -330,12 +256,13 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/kotlinSdk | -
- - 2.3.1.1. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | +| - [outputDir](#generate_kotlinSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [package](#generate_kotlinSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | +| - [](#generate_kotlinSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.3.1.1. Property `root > generate > kotlinSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -344,15 +271,7 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
- - 2.3.1.2. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > package - - -
+##### 2.3.1.2. Property `root > generate > kotlinSdk > oneOf > item 0 > package` | | | | ------------ | -------- | @@ -361,12 +280,6 @@ **Description:** The package name to use for the generated code. -
-
- -
-
- #### 2.3.2. Property `root > generate > kotlinSdk > oneOf > item 1` | | | @@ -386,7 +299,7 @@ | ----------------------------------------------- | ----------- | | [kotlinSdk](#generate_kotlinSdk_oneOf_i1_items) | - | -##### 2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk +##### 2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk | | | | ------------------------- | ----------------------------------------------------------- | @@ -395,19 +308,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_kotlinSdk_oneOf_i0](#generate_kotlinSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.4. [Optional] Property root > generate > swiftSdk - - -
+### 2.4. Property `root > generate > swiftSdk` | | | | ------------------------- | ---------------- | @@ -417,15 +318,11 @@ **Description:** Configuration for a generated Swift SDK -
- | One of(Option) | | --------------------------------------- | | [swiftSdk](#generate_swiftSdk_oneOf_i0) | | [item 1](#generate_swiftSdk_oneOf_i1) | -
- #### 2.4.1. Property `root > generate > swiftSdk > oneOf > swiftSdk` | | | @@ -435,12 +332,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/swiftSdk | -
- - 2.4.1.1. [Optional] Property root > generate > swiftSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | +| - [outputDir](#generate_swiftSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [](#generate_swiftSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.4.1.1. Property `root > generate > swiftSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -449,12 +346,6 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
-
- #### 2.4.2. Property `root > generate > swiftSdk > oneOf > item 1` | | | @@ -474,7 +365,7 @@ | --------------------------------------------- | ----------- | | [swiftSdk](#generate_swiftSdk_oneOf_i1_items) | - | -##### 2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk +##### 2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk | | | | ------------------------- | --------------------------------------------------------- | @@ -483,19 +374,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_swiftSdk_oneOf_i0](#generate_swiftSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.5. [Optional] Property root > generate > llmTools - - -
+### 2.5. Property `root > generate > llmTools` | | | | ------------------------- | ---------------- | @@ -503,15 +382,11 @@ | **Required** | No | | **Additional properties** | Any type allowed | -
- | One of(Option) | | --------------------------------------- | | [llmTools](#generate_llmTools_oneOf_i0) | | [item 1](#generate_llmTools_oneOf_i1) | -
- #### 2.5.1. Property `root > generate > llmTools > oneOf > llmTools` | | | @@ -521,12 +396,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/llmTools | -
- - 2.5.1.1. [Optional] Property root > generate > llmTools > oneOf > item 0 > outputFile +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------ | +| - [outputFile](#generate_llmTools_oneOf_i0_outputFile ) | No | string | No | - | Path where the JSON LLM tool definitions file should be generated. | +| - [](#generate_llmTools_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.5.1.1. Property `root > generate > llmTools > oneOf > item 0 > outputFile` | | | | ------------ | -------- | @@ -535,12 +410,6 @@ **Description:** Path where the JSON LLM tool definitions file should be generated. -
-
- -
-
- #### 2.5.2. Property `root > generate > llmTools > oneOf > item 1` | | | @@ -560,7 +429,7 @@ | --------------------------------------------- | ----------- | | [llmTools](#generate_llmTools_oneOf_i1_items) | - | -##### 2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools +##### 2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools | | | | ------------------------- | --------------------------------------------------------- | @@ -569,15 +438,5 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_llmTools_oneOf_i0](#generate_llmTools_oneOf_i0) | -
- -
- -
-
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 diff --git a/schema/docs/dataconnect-yaml.md b/schema/docs/dataconnect-yaml.md index c2f73477eb4..6e2b236e572 100644 --- a/schema/docs/dataconnect-yaml.md +++ b/schema/docs/dataconnect-yaml.md @@ -1,18 +1,18 @@ # Schema Docs -- [1. [Optional] Property root > specVersion](#specVersion) -- [2. [Optional] Property root > serviceId](#serviceId) -- [3. [Optional] Property root > location](#location) -- [4. [Optional] Property root > connectorDirs](#connectorDirs) - - [4.1. root > connectorDirs > connectorDirs items](#autogenerated_heading_2) -- [5. [Optional] Property root > schema](#schema) - - [5.1. [Optional] Property root > schema > source](#schema_source) - - [5.2. [Optional] Property root > schema > datasource](#schema_datasource) - - [5.2.1. [Optional] Property root > schema > datasource > postgresql](#schema_datasource_postgresql) - - [5.2.1.1. [Optional] Property root > schema > datasource > postgresql > database](#schema_datasource_postgresql_database) - - [5.2.1.2. [Optional] Property root > schema > datasource > postgresql > cloudSql](#schema_datasource_postgresql_cloudSql) - - [5.2.1.2.1. [Optional] Property root > schema > datasource > postgresql > cloudSql > instanceId](#schema_datasource_postgresql_cloudSql_instanceId) - - [5.2.1.2.2. [Optional] Property root > schema > datasource > postgresql > cloudSql > schemaValidation](#schema_datasource_postgresql_cloudSql_schemaValidation) +- [1. Property `root > specVersion`](#specVersion) +- [2. Property `root > serviceId`](#serviceId) +- [3. Property `root > location`](#location) +- [4. Property `root > connectorDirs`](#connectorDirs) + - [4.1. root > connectorDirs > connectorDirs items](#connectorDirs_items) +- [5. Property `root > schema`](#schema) + - [5.1. Property `root > schema > source`](#schema_source) + - [5.2. Property `root > schema > datasource`](#schema_datasource) + - [5.2.1. Property `root > schema > datasource > postgresql`](#schema_datasource_postgresql) + - [5.2.1.1. Property `root > schema > datasource > postgresql > database`](#schema_datasource_postgresql_database) + - [5.2.1.2. Property `root > schema > datasource > postgresql > cloudSql`](#schema_datasource_postgresql_cloudSql) + - [5.2.1.2.1. Property `root > schema > datasource > postgresql > cloudSql > instanceId`](#schema_datasource_postgresql_cloudSql_instanceId) + - [5.2.1.2.2. Property `root > schema > datasource > postgresql > cloudSql > schemaValidation`](#schema_datasource_postgresql_cloudSql_schemaValidation) | | | | ------------------------- | ----------- | @@ -22,12 +22,15 @@ **Description:** dataconnect.yaml is how you configure a Firebase Data Connect service. -
- - 1. [Optional] Property root > specVersion +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | --------------- | ---------- | ----------------------- | ------------------------------------------------------------------------------------------- | +| - [specVersion](#specVersion ) | No | string | No | - | The Firebase Data Connect API version to target. If omitted, defaults to the latest version | +| - [serviceId](#serviceId ) | No | string | No | - | The ID of the Firebase Data Connect service. | +| - [location](#location ) | No | string | No | - | The region of the Firebase Data Connect service. | +| - [connectorDirs](#connectorDirs ) | No | array of string | No | - | A list of directories containing conector.yaml files describing a connector to deploy. | +| - [schema](#schema ) | No | object | No | In #/definitions/schema | - | - -
+## 1. Property `root > specVersion` | | | | ------------ | -------- | @@ -36,15 +39,7 @@ **Description:** The Firebase Data Connect API version to target. If omitted, defaults to the latest version -
-
- -
- - 2. [Optional] Property root > serviceId - - -
+## 2. Property `root > serviceId` | | | | ------------ | -------- | @@ -53,15 +48,7 @@ **Description:** The ID of the Firebase Data Connect service. -
-
- -
- - 3. [Optional] Property root > location - - -
+## 3. Property `root > location` | | | | ------------ | -------- | @@ -70,15 +57,7 @@ **Description:** The region of the Firebase Data Connect service. -
-
- -
- - 4. [Optional] Property root > connectorDirs - - -
+## 4. Property `root > connectorDirs` | | | | ------------ | ----------------- | @@ -99,22 +78,14 @@ | ------------------------------------------- | ----------- | | [connectorDirs items](#connectorDirs_items) | - | -### 4.1. root > connectorDirs > connectorDirs items +### 4.1. root > connectorDirs > connectorDirs items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 5. [Optional] Property root > schema - - -
+## 5. Property `root > schema` | | | | ------------------------- | -------------------- | @@ -123,12 +94,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/schema | -
- - 5.1. [Optional] Property root > schema > source +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------ | +| - [source](#schema_source ) | No | string | No | - | Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema. | +| - [datasource](#schema_datasource ) | No | object | No | In #/definitions/dataSource | - | - -
+### 5.1. Property `root > schema > source` | | | | ------------ | -------- | @@ -137,15 +108,7 @@ **Description:** Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema. -
-
- -
- - 5.2. [Optional] Property root > schema > datasource - - -
+### 5.2. Property `root > schema > datasource` | | | | ------------------------- | ------------------------ | @@ -154,12 +117,11 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/dataSource | -
- - 5.2.1. [Optional] Property root > schema > datasource > postgresql +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------- | ------- | ------ | ---------- | --------------------------- | ----------------- | +| - [postgresql](#schema_datasource_postgresql ) | No | object | No | In #/definitions/postgresql | - | - -
+#### 5.2.1. Property `root > schema > datasource > postgresql` | | | | ------------------------- | ------------------------ | @@ -168,12 +130,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/postgresql | -
- - 5.2.1.1. [Optional] Property root > schema > datasource > postgresql > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------ | +| - [database](#schema_datasource_postgresql_database ) | No | string | No | - | The name of the PostgreSQL database. | +| - [cloudSql](#schema_datasource_postgresql_cloudSql ) | No | object | No | - | - | - -
+##### 5.2.1.1. Property `root > schema > datasource > postgresql > database` | | | | ------------ | -------- | @@ -182,15 +144,7 @@ **Description:** The name of the PostgreSQL database. -
-
- -
- - 5.2.1.2. [Optional] Property root > schema > datasource > postgresql > cloudSql - - -
+##### 5.2.1.2. Property `root > schema > datasource > postgresql > cloudSql` | | | | ------------------------- | ----------- | @@ -198,12 +152,12 @@ | **Required** | No | | **Additional properties** | Not allowed | -
- - 5.2.1.2.1. [Optional] Property root > schema > datasource > postgresql > cloudSql > instanceId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------- | +| - [instanceId](#schema_datasource_postgresql_cloudSql_instanceId ) | No | string | No | - | The ID of the CloudSQL instance for this database | +| - [schemaValidation](#schema_datasource_postgresql_cloudSql_schemaValidation ) | No | enum (of string) | No | - | Schema validation mode for schema migrations | - -
+###### 5.2.1.2.1. Property `root > schema > datasource > postgresql > cloudSql > instanceId` | | | | ------------ | -------- | @@ -212,15 +166,7 @@ **Description:** The ID of the CloudSQL instance for this database -
-
- -
- - 5.2.1.2.2. [Optional] Property root > schema > datasource > postgresql > cloudSql > schemaValidation - - -
+###### 5.2.1.2.2. Property `root > schema > datasource > postgresql > cloudSql > schemaValidation` | | | | ------------ | ------------------ | @@ -233,20 +179,5 @@ Must be one of: * "COMPATIBLE" * "STRICT" -
-
- -
-
- -
-
- -
-
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 diff --git a/schema/docs/extension-yaml.md b/schema/docs/extension-yaml.md index a98311e3445..0a9bddec2d0 100644 --- a/schema/docs/extension-yaml.md +++ b/schema/docs/extension-yaml.md @@ -1,97 +1,97 @@ # Schema Docs -- [1. [Optional] Property root > name](#name) -- [2. [Optional] Property root > version](#version) -- [3. [Optional] Property root > specVersion](#specVersion) -- [4. [Optional] Property root > license](#license) -- [5. [Optional] Property root > displayName](#displayName) -- [6. [Optional] Property root > description](#description) -- [7. [Optional] Property root > icon](#icon) -- [8. [Optional] Property root > billingRequired](#billingRequired) -- [9. [Optional] Property root > tags](#tags) - - [9.1. root > tags > tags items](#autogenerated_heading_2) -- [10. [Optional] Property root > sourceUrl](#sourceUrl) -- [11. [Optional] Property root > releaseNotesUrl](#releaseNotesUrl) -- [12. [Optional] Property root > author](#author) - - [12.1. [Optional] Property root > author > authorName](#author_authorName) - - [12.2. [Optional] Property root > author > email](#author_email) - - [12.3. [Optional] Property root > author > url](#author_url) -- [13. [Optional] Property root > contributors](#contributors) - - [13.1. root > contributors > author](#autogenerated_heading_3) -- [14. [Optional] Property root > apis](#apis) - - [14.1. root > apis > api](#autogenerated_heading_4) - - [14.1.1. [Required] Property root > apis > apis items > apiName](#apis_items_apiName) - - [14.1.2. [Required] Property root > apis > apis items > reason](#apis_items_reason) -- [15. [Optional] Property root > roles](#roles) - - [15.1. root > roles > role](#autogenerated_heading_5) - - [15.1.1. [Required] Property root > roles > roles items > role](#roles_items_role) - - [15.1.2. [Required] Property root > roles > roles items > reason](#roles_items_reason) - - [15.1.3. [Optional] Property root > roles > roles items > resource](#roles_items_resource) -- [16. [Optional] Property root > externalServices](#externalServices) - - [16.1. root > externalServices > externalService](#autogenerated_heading_6) - - [16.1.1. [Optional] Property root > externalServices > externalServices items > name](#externalServices_items_name) - - [16.1.2. [Optional] Property root > externalServices > externalServices items > pricingUri](#externalServices_items_pricingUri) -- [17. [Optional] Property root > params](#params) - - [17.1. root > params > param](#autogenerated_heading_7) - - [17.1.1. [Required] Property root > params > params items > param](#params_items_param) - - [17.1.2. [Optional] Property root > params > params items > label](#params_items_label) - - [17.1.3. [Optional] Property root > params > params items > description](#params_items_description) - - [17.1.4. [Optional] Property root > params > params items > example](#params_items_example) - - [17.1.5. [Optional] Property root > params > params items > validationRegex](#params_items_validationRegex) - - [17.1.6. [Optional] Property root > params > params items > validationErrorMessage](#params_items_validationErrorMessage) - - [17.1.7. [Optional] Property root > params > params items > default](#params_items_default) - - [17.1.8. [Optional] Property root > params > params items > required](#params_items_required) - - [17.1.9. [Optional] Property root > params > params items > immutable](#params_items_immutable) - - [17.1.10. [Optional] Property root > params > params items > advanced](#params_items_advanced) - - [17.1.11. [Optional] Property root > params > params items > type](#params_items_type) - - [17.1.12. [Optional] Property root > params > params items > resourceType](#params_items_resourceType) - - [17.1.13. [Optional] Property root > params > params items > options](#params_items_options) - - [17.1.13.1. root > params > params items > options > paramOption](#autogenerated_heading_8) - - [17.1.13.1.1. [Required] Property root > params > params items > options > options items > value](#params_items_options_items_value) - - [17.1.13.1.2. [Optional] Property root > params > params items > options > options items > label](#params_items_options_items_label) -- [18. [Optional] Property root > resources](#resources) - - [18.1. root > resources > resource](#autogenerated_heading_9) - - [18.1.1. [Required] Property root > resources > resources items > name](#resources_items_name) - - [18.1.2. [Required] Property root > resources > resources items > type](#resources_items_type) - - [18.1.3. [Required] Property root > resources > resources items > description](#resources_items_description) - - [18.1.4. [Required] Property root > resources > resources items > properties](#resources_items_properties) - - [18.1.4.1. [Optional] Property root > resources > resources items > properties > location](#resources_items_properties_location) - - [18.1.4.2. [Optional] Property root > resources > resources items > properties > entryPoint](#resources_items_properties_entryPoint) - - [18.1.4.3. [Optional] Property root > resources > resources items > properties > sourceDirectory](#resources_items_properties_sourceDirectory) - - [18.1.4.4. [Optional] Property root > resources > resources items > properties > timeout](#resources_items_properties_timeout) - - [18.1.4.5. [Optional] Property root > resources > resources items > properties > availableMemoryMb](#resources_items_properties_availableMemoryMb) - - [18.1.4.6. [Optional] Property root > resources > resources items > properties > runtime](#resources_items_properties_runtime) - - [18.1.4.7. [Optional] Property root > resources > resources items > properties > httpsTrigger](#resources_items_properties_httpsTrigger) - - [18.1.4.8. [Optional] Property root > resources > resources items > properties > eventTrigger](#resources_items_properties_eventTrigger) - - [18.1.4.8.1. [Required] Property root > resources > resources items > properties > eventTrigger > eventType](#resources_items_properties_eventTrigger_eventType) - - [18.1.4.8.2. [Optional] Property root > resources > resources items > properties > eventTrigger > resource](#resources_items_properties_eventTrigger_resource) - - [18.1.4.8.3. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters](#resources_items_properties_eventTrigger_eventFilters) - - [18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter](#autogenerated_heading_10) - - [18.1.4.8.3.1.1. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute](#resources_items_properties_eventTrigger_eventFilters_items_attribute) - - [18.1.4.8.3.1.2. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value](#resources_items_properties_eventTrigger_eventFilters_items_value) - - [18.1.4.8.4. [Optional] Property root > resources > resources items > properties > eventTrigger > channel](#resources_items_properties_eventTrigger_channel) - - [18.1.4.8.5. [Optional] Property root > resources > resources items > properties > eventTrigger > triggerRegion](#resources_items_properties_eventTrigger_triggerRegion) - - [18.1.4.9. [Optional] Property root > resources > resources items > properties > scheduleTrigger](#resources_items_properties_scheduleTrigger) - - [18.1.4.9.1. [Required] Property root > resources > resources items > properties > scheduleTrigger > schedule](#resources_items_properties_scheduleTrigger_schedule) - - [18.1.4.9.2. [Optional] Property root > resources > resources items > properties > scheduleTrigger > timeZone](#resources_items_properties_scheduleTrigger_timeZone) - - [18.1.4.10. [Optional] Property root > resources > resources items > properties > taskQueueTrigger](#resources_items_properties_taskQueueTrigger) - - [18.1.4.11. [Optional] Property root > resources > resources items > properties > buildConfig](#resources_items_properties_buildConfig) - - [18.1.4.11.1. [Optional] Property root > resources > resources items > properties > buildConfig > runtime](#resources_items_properties_buildConfig_runtime) - - [18.1.4.11.2. [Optional] Property root > resources > resources items > properties > buildConfig > entryPoint](#resources_items_properties_buildConfig_entryPoint) - - [18.1.4.12. [Optional] Property root > resources > resources items > properties > serviceConfig](#resources_items_properties_serviceConfig) - - [18.1.4.12.1. [Optional] Property root > resources > resources items > properties > serviceConfig > timeoutSeconds](#resources_items_properties_serviceConfig_timeoutSeconds) - - [18.1.4.12.2. [Optional] Property root > resources > resources items > properties > serviceConfig > availableMemory](#resources_items_properties_serviceConfig_availableMemory) -- [19. [Optional] Property root > lifecycleEvents](#lifecycleEvents) - - [19.1. root > lifecycleEvents > lifecycleEvent](#autogenerated_heading_11) - - [19.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall](#lifecycleEvents_items_onInstall) - - [19.1.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > function](#lifecycleEvents_items_onInstall_function) - - [19.1.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage](#lifecycleEvents_items_onInstall_processingMessage) - - [19.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onUpdate](#lifecycleEvents_items_onUpdate) - - [19.1.3. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onConfigure](#lifecycleEvents_items_onConfigure) -- [20. [Optional] Property root > events](#events) - - [20.1. root > events > event](#autogenerated_heading_12) - - [20.1.1. [Optional] Property root > events > events items > type](#events_items_type) - - [20.1.2. [Optional] Property root > events > events items > description](#events_items_description) +- [1. Property `root > name`](#name) +- [2. Property `root > version`](#version) +- [3. Property `root > specVersion`](#specVersion) +- [4. Property `root > license`](#license) +- [5. Property `root > displayName`](#displayName) +- [6. Property `root > description`](#description) +- [7. Property `root > icon`](#icon) +- [8. Property `root > billingRequired`](#billingRequired) +- [9. Property `root > tags`](#tags) + - [9.1. root > tags > tags items](#tags_items) +- [10. Property `root > sourceUrl`](#sourceUrl) +- [11. Property `root > releaseNotesUrl`](#releaseNotesUrl) +- [12. Property `root > author`](#author) + - [12.1. Property `root > author > authorName`](#author_authorName) + - [12.2. Property `root > author > email`](#author_email) + - [12.3. Property `root > author > url`](#author_url) +- [13. Property `root > contributors`](#contributors) + - [13.1. root > contributors > author](#contributors_items) +- [14. Property `root > apis`](#apis) + - [14.1. root > apis > api](#apis_items) + - [14.1.1. Property `root > apis > apis items > apiName`](#apis_items_apiName) + - [14.1.2. Property `root > apis > apis items > reason`](#apis_items_reason) +- [15. Property `root > roles`](#roles) + - [15.1. root > roles > role](#roles_items) + - [15.1.1. Property `root > roles > roles items > role`](#roles_items_role) + - [15.1.2. Property `root > roles > roles items > reason`](#roles_items_reason) + - [15.1.3. Property `root > roles > roles items > resource`](#roles_items_resource) +- [16. Property `root > externalServices`](#externalServices) + - [16.1. root > externalServices > externalService](#externalServices_items) + - [16.1.1. Property `root > externalServices > externalServices items > name`](#externalServices_items_name) + - [16.1.2. Property `root > externalServices > externalServices items > pricingUri`](#externalServices_items_pricingUri) +- [17. Property `root > params`](#params) + - [17.1. root > params > param](#params_items) + - [17.1.1. Property `root > params > params items > param`](#params_items_param) + - [17.1.2. Property `root > params > params items > label`](#params_items_label) + - [17.1.3. Property `root > params > params items > description`](#params_items_description) + - [17.1.4. Property `root > params > params items > example`](#params_items_example) + - [17.1.5. Property `root > params > params items > validationRegex`](#params_items_validationRegex) + - [17.1.6. Property `root > params > params items > validationErrorMessage`](#params_items_validationErrorMessage) + - [17.1.7. Property `root > params > params items > default`](#params_items_default) + - [17.1.8. Property `root > params > params items > required`](#params_items_required) + - [17.1.9. Property `root > params > params items > immutable`](#params_items_immutable) + - [17.1.10. Property `root > params > params items > advanced`](#params_items_advanced) + - [17.1.11. Property `root > params > params items > type`](#params_items_type) + - [17.1.12. Property `root > params > params items > resourceType`](#params_items_resourceType) + - [17.1.13. Property `root > params > params items > options`](#params_items_options) + - [17.1.13.1. root > params > params items > options > paramOption](#params_items_options_items) + - [17.1.13.1.1. Property `root > params > params items > options > options items > value`](#params_items_options_items_value) + - [17.1.13.1.2. Property `root > params > params items > options > options items > label`](#params_items_options_items_label) +- [18. Property `root > resources`](#resources) + - [18.1. root > resources > resource](#resources_items) + - [18.1.1. Property `root > resources > resources items > name`](#resources_items_name) + - [18.1.2. Property `root > resources > resources items > type`](#resources_items_type) + - [18.1.3. Property `root > resources > resources items > description`](#resources_items_description) + - [18.1.4. Property `root > resources > resources items > properties`](#resources_items_properties) + - [18.1.4.1. Property `root > resources > resources items > properties > location`](#resources_items_properties_location) + - [18.1.4.2. Property `root > resources > resources items > properties > entryPoint`](#resources_items_properties_entryPoint) + - [18.1.4.3. Property `root > resources > resources items > properties > sourceDirectory`](#resources_items_properties_sourceDirectory) + - [18.1.4.4. Property `root > resources > resources items > properties > timeout`](#resources_items_properties_timeout) + - [18.1.4.5. Property `root > resources > resources items > properties > availableMemoryMb`](#resources_items_properties_availableMemoryMb) + - [18.1.4.6. Property `root > resources > resources items > properties > runtime`](#resources_items_properties_runtime) + - [18.1.4.7. Property `root > resources > resources items > properties > httpsTrigger`](#resources_items_properties_httpsTrigger) + - [18.1.4.8. Property `root > resources > resources items > properties > eventTrigger`](#resources_items_properties_eventTrigger) + - [18.1.4.8.1. Property `root > resources > resources items > properties > eventTrigger > eventType`](#resources_items_properties_eventTrigger_eventType) + - [18.1.4.8.2. Property `root > resources > resources items > properties > eventTrigger > resource`](#resources_items_properties_eventTrigger_resource) + - [18.1.4.8.3. Property `root > resources > resources items > properties > eventTrigger > eventFilters`](#resources_items_properties_eventTrigger_eventFilters) + - [18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter](#resources_items_properties_eventTrigger_eventFilters_items) + - [18.1.4.8.3.1.1. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute`](#resources_items_properties_eventTrigger_eventFilters_items_attribute) + - [18.1.4.8.3.1.2. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value`](#resources_items_properties_eventTrigger_eventFilters_items_value) + - [18.1.4.8.4. Property `root > resources > resources items > properties > eventTrigger > channel`](#resources_items_properties_eventTrigger_channel) + - [18.1.4.8.5. Property `root > resources > resources items > properties > eventTrigger > triggerRegion`](#resources_items_properties_eventTrigger_triggerRegion) + - [18.1.4.9. Property `root > resources > resources items > properties > scheduleTrigger`](#resources_items_properties_scheduleTrigger) + - [18.1.4.9.1. Property `root > resources > resources items > properties > scheduleTrigger > schedule`](#resources_items_properties_scheduleTrigger_schedule) + - [18.1.4.9.2. Property `root > resources > resources items > properties > scheduleTrigger > timeZone`](#resources_items_properties_scheduleTrigger_timeZone) + - [18.1.4.10. Property `root > resources > resources items > properties > taskQueueTrigger`](#resources_items_properties_taskQueueTrigger) + - [18.1.4.11. Property `root > resources > resources items > properties > buildConfig`](#resources_items_properties_buildConfig) + - [18.1.4.11.1. Property `root > resources > resources items > properties > buildConfig > runtime`](#resources_items_properties_buildConfig_runtime) + - [18.1.4.11.2. Property `root > resources > resources items > properties > buildConfig > entryPoint`](#resources_items_properties_buildConfig_entryPoint) + - [18.1.4.12. Property `root > resources > resources items > properties > serviceConfig`](#resources_items_properties_serviceConfig) + - [18.1.4.12.1. Property `root > resources > resources items > properties > serviceConfig > timeoutSeconds`](#resources_items_properties_serviceConfig_timeoutSeconds) + - [18.1.4.12.2. Property `root > resources > resources items > properties > serviceConfig > availableMemory`](#resources_items_properties_serviceConfig_availableMemory) +- [19. Property `root > lifecycleEvents`](#lifecycleEvents) + - [19.1. root > lifecycleEvents > lifecycleEvent](#lifecycleEvents_items) + - [19.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall`](#lifecycleEvents_items_onInstall) + - [19.1.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > function`](#lifecycleEvents_items_onInstall_function) + - [19.1.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage`](#lifecycleEvents_items_onInstall_processingMessage) + - [19.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onUpdate`](#lifecycleEvents_items_onUpdate) + - [19.1.3. Property `root > lifecycleEvents > lifecycleEvents items > onConfigure`](#lifecycleEvents_items_onConfigure) +- [20. Property `root > events`](#events) + - [20.1. root > events > event](#events_items) + - [20.1.1. Property `root > events > events items > type`](#events_items_type) + - [20.1.2. Property `root > events > events items > description`](#events_items_description) | | | | ------------------------- | ----------- | @@ -101,12 +101,30 @@ **Description:** extension.yaml declares the resources and configurable parameters for a Firebase Extension. -
- - 1. [Optional] Property root > name - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------- | ------- | --------------- | ---------- | ----------------------- | -------------------------------------------------------------------------------------------------------------- | +| - [name](#name ) | No | string | No | - | ID of this extension (ie your-extension-name) | +| - [version](#version ) | No | string | No | - | Version of this extension. Follows https://semver.org/. | +| - [specVersion](#specVersion ) | No | string | No | - | Version of the extension.yaml spec that this file follows. Currently always 'v1beta' | +| - [license](#license ) | No | string | No | - | The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev | +| - [displayName](#displayName ) | No | string | No | - | Human readable name for this extension (ie 'Your Extension Name') | +| - [description](#description ) | No | string | No | - | A one to two sentence description of what this extension does | +| - [icon](#icon ) | No | string | No | - | The file name of this extension's icon | +| - [billingRequired](#billingRequired ) | No | boolean | No | - | Whether this extension requires a billing to be enabled on the project it is installed on | +| - [tags](#tags ) | No | array of string | No | - | A list of tags to help users find your extension in search | +| - [sourceUrl](#sourceUrl ) | No | string | No | - | The URL of the GitHub repo hosting this code | +| - [releaseNotesUrl](#releaseNotesUrl ) | No | string | No | - | A URL where users can view the full changelog or release notes for this extension | +| - [author](#author ) | No | object | No | In #/definitions/author | - | +| - [contributors](#contributors ) | No | array | No | - | - | +| - [apis](#apis ) | No | array | No | - | - | +| - [roles](#roles ) | No | array | No | - | - | +| - [externalServices](#externalServices ) | No | array | No | - | - | +| - [params](#params ) | No | array | No | - | - | +| - [resources](#resources ) | No | array | No | - | - | +| - [lifecycleEvents](#lifecycleEvents ) | No | array | No | - | - | +| - [events](#events ) | No | array | No | - | - | + +## 1. Property `root > name` | | | | ------------ | -------- | @@ -115,15 +133,7 @@ **Description:** ID of this extension (ie your-extension-name) -
-
- -
- - 2. [Optional] Property root > version - - -
+## 2. Property `root > version` | | | | ------------ | -------- | @@ -132,15 +142,7 @@ **Description:** Version of this extension. Follows https://semver.org/. -
-
- -
- - 3. [Optional] Property root > specVersion - - -
+## 3. Property `root > specVersion` | | | | ------------ | -------- | @@ -149,15 +151,7 @@ **Description:** Version of the extension.yaml spec that this file follows. Currently always 'v1beta' -
-
- -
- - 4. [Optional] Property root > license - - -
+## 4. Property `root > license` | | | | ------------ | -------- | @@ -166,15 +160,7 @@ **Description:** The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev -
-
- -
- - 5. [Optional] Property root > displayName - - -
+## 5. Property `root > displayName` | | | | ------------ | -------- | @@ -183,15 +169,7 @@ **Description:** Human readable name for this extension (ie 'Your Extension Name') -
-
- -
- - 6. [Optional] Property root > description - - -
+## 6. Property `root > description` | | | | ------------ | -------- | @@ -200,15 +178,7 @@ **Description:** A one to two sentence description of what this extension does -
-
- -
- - 7. [Optional] Property root > icon - - -
+## 7. Property `root > icon` | | | | ------------ | -------- | @@ -217,15 +187,7 @@ **Description:** The file name of this extension's icon -
-
- -
- - 8. [Optional] Property root > billingRequired - - -
+## 8. Property `root > billingRequired` | | | | ------------ | --------- | @@ -234,15 +196,7 @@ **Description:** Whether this extension requires a billing to be enabled on the project it is installed on -
-
- -
- - 9. [Optional] Property root > tags - - -
+## 9. Property `root > tags` | | | | ------------ | ----------------- | @@ -263,22 +217,14 @@ | ------------------------------- | ----------- | | [tags items](#tags_items) | - | -### 9.1. root > tags > tags items +### 9.1. root > tags > tags items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 10. [Optional] Property root > sourceUrl - - -
+## 10. Property `root > sourceUrl` | | | | ------------ | -------- | @@ -287,15 +233,7 @@ **Description:** The URL of the GitHub repo hosting this code -
-
- -
- - 11. [Optional] Property root > releaseNotesUrl - - -
+## 11. Property `root > releaseNotesUrl` | | | | ------------ | -------- | @@ -304,15 +242,7 @@ **Description:** A URL where users can view the full changelog or release notes for this extension -
-
- -
- - 12. [Optional] Property root > author - - -
+## 12. Property `root > author` | | | | ------------------------- | -------------------- | @@ -321,12 +251,13 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/author | -
- - 12.1. [Optional] Property root > author > authorName +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ | +| - [authorName](#author_authorName ) | No | string | No | - | The author's name | +| - [email](#author_email ) | No | string | No | - | A contact email for the author | +| - [url](#author_url ) | No | string | No | - | URL of the author's website | - -
+### 12.1. Property `root > author > authorName` | | | | ------------ | -------- | @@ -335,15 +266,7 @@ **Description:** The author's name -
-
- -
- - 12.2. [Optional] Property root > author > email - - -
+### 12.2. Property `root > author > email` | | | | ------------ | -------- | @@ -352,15 +275,7 @@ **Description:** A contact email for the author -
-
- -
- - 12.3. [Optional] Property root > author > url - - -
+### 12.3. Property `root > author > url` | | | | ------------ | -------- | @@ -369,18 +284,7 @@ **Description:** URL of the author's website -
-
- -
-
- -
- - 13. [Optional] Property root > contributors - - -
+## 13. Property `root > contributors` | | | | ------------ | ------- | @@ -399,7 +303,7 @@ | ------------------------------- | ----------- | | [author](#contributors_items) | - | -### 13.1. root > contributors > author +### 13.1. root > contributors > author | | | | ------------------------- | ----------------- | @@ -408,15 +312,7 @@ | **Additional properties** | Not allowed | | **Same definition as** | [author](#author) | -
-
- -
- - 14. [Optional] Property root > apis - - -
+## 14. Property `root > apis` | | | | ------------ | ------- | @@ -435,7 +331,7 @@ | ------------------------------- | ----------------------------------------------------------------------------- | | [api](#apis_items) | A Google API used by this extension. Will be enabled on extension deployment. | -### 14.1. root > apis > api +### 14.1. root > apis > api | | | | ------------------------- | ----------------- | @@ -446,12 +342,12 @@ **Description:** A Google API used by this extension. Will be enabled on extension deployment. -
- - 14.1.1. [Required] Property root > apis > apis items > apiName +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------- | +| + [apiName](#apis_items_apiName ) | No | string | No | - | Name of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library | +| + [reason](#apis_items_reason ) | No | string | No | - | Why this extension needs this API enabled | - -
+#### 14.1.1. Property `root > apis > apis items > apiName` | | | | ------------ | -------- | @@ -464,15 +360,7 @@ | --------------------------------- | ------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```[^\.]+\.googleapis\.com``` [Test](https://regex101.com/?regex=%5B%5E%5C.%5D%2B%5C.googleapis%5C.com) | -
-
- -
- - 14.1.2. [Required] Property root > apis > apis items > reason - - -
+#### 14.1.2. Property `root > apis > apis items > reason` | | | | ------------ | -------- | @@ -481,18 +369,7 @@ **Description:** Why this extension needs this API enabled -
-
- -
-
- -
- - 15. [Optional] Property root > roles - - -
+## 15. Property `root > roles` | | | | ------------ | ------- | @@ -511,7 +388,7 @@ | ------------------------------- | --------------------------------------- | | [role](#roles_items) | An IAM role to grant to this extension. | -### 15.1. root > roles > role +### 15.1. root > roles > role | | | | ------------------------- | ------------------ | @@ -522,12 +399,13 @@ **Description:** An IAM role to grant to this extension. -
- - 15.1.1. [Required] Property root > roles > roles items > role +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [role](#roles_items_role ) | No | string | No | - | Name of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles | +| + [reason](#roles_items_reason ) | No | string | No | - | Why this extension needs this IAM role | +| - [resource](#roles_items_resource ) | No | string | No | - | What resource to grant this role on. If omitted, defaults to projects/${project_id} | - -
+#### 15.1.1. Property `root > roles > roles items > role` | | | | ------------ | -------- | @@ -540,15 +418,7 @@ | --------------------------------- | ------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```[a-zA-Z]+\.[a-zA-Z]+``` [Test](https://regex101.com/?regex=%5Ba-zA-Z%5D%2B%5C.%5Ba-zA-Z%5D%2B) | -
-
- -
- - 15.1.2. [Required] Property root > roles > roles items > reason - - -
+#### 15.1.2. Property `root > roles > roles items > reason` | | | | ------------ | -------- | @@ -557,15 +427,7 @@ **Description:** Why this extension needs this IAM role -
-
- -
- - 15.1.3. [Optional] Property root > roles > roles items > resource - - -
+#### 15.1.3. Property `root > roles > roles items > resource` | | | | ------------ | -------- | @@ -574,18 +436,7 @@ **Description:** What resource to grant this role on. If omitted, defaults to projects/${project_id} -
-
- -
-
- -
- - 16. [Optional] Property root > externalServices - - -
+## 16. Property `root > externalServices` | | | | ------------ | ------- | @@ -604,7 +455,7 @@ | ------------------------------------------ | --------------------------------------- | | [externalService](#externalServices_items) | A non-Google API used by this extension | -### 16.1. root > externalServices > externalService +### 16.1. root > externalServices > externalService | | | | ------------------------- | ----------------------------- | @@ -615,12 +466,12 @@ **Description:** A non-Google API used by this extension -
- - 16.1.1. [Optional] Property root > externalServices > externalServices items > name +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [name](#externalServices_items_name ) | No | string | No | - | Name of the external service | +| - [pricingUri](#externalServices_items_pricingUri ) | No | string | No | - | URI to pricing information for the service | - -
+#### 16.1.1. Property `root > externalServices > externalServices items > name` | | | | ------------ | -------- | @@ -629,15 +480,7 @@ **Description:** Name of the external service -
-
- -
- - 16.1.2. [Optional] Property root > externalServices > externalServices items > pricingUri - - -
+#### 16.1.2. Property `root > externalServices > externalServices items > pricingUri` | | | | ------------ | -------- | @@ -646,18 +489,7 @@ **Description:** URI to pricing information for the service -
-
- -
-
- -
- - 17. [Optional] Property root > params - - -
+## 17. Property `root > params` | | | | ------------ | ------- | @@ -676,7 +508,7 @@ | ------------------------------- | -------------------------------------------------------------- | | [param](#params_items) | A parameter that users installing this extension can configure | -### 17.1. root > params > param +### 17.1. root > params > param | | | | ------------------------- | ------------------- | @@ -687,12 +519,23 @@ **Description:** A parameter that users installing this extension can configure -
- - 17.1.1. [Required] Property root > params > params items > param - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [param](#params_items_param ) | No | string | No | - | The name of the param. This is how you reference the param in your code | +| - [label](#params_items_label ) | No | string | No | - | Short description for the parameter. Displayed to users when they're prompted for the parameter's value. | +| - [description](#params_items_description ) | No | string | No | - | Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value. | +| - [example](#params_items_example ) | No | string | No | - | Example value for the parameter. | +| - [validationRegex](#params_items_validationRegex ) | No | string | No | - | Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax. | +| - [validationErrorMessage](#params_items_validationErrorMessage ) | No | string | No | - | Error message to display if regex validation fails. | +| - [default](#params_items_default ) | No | string | No | - | Default value for the parameter if the user leaves the parameter's value blank. | +| - [required](#params_items_required ) | No | boolean | No | - | Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true. | +| - [immutable](#params_items_immutable ) | No | boolean | No | - | Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false. | +| - [advanced](#params_items_advanced ) | No | boolean | No | - | Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param. | +| - [type](#params_items_type ) | No | string | No | - | The parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details. | +| - [resourceType](#params_items_resourceType ) | No | string | No | - | The type of resource to prompt the user to select. Provides a special UI treatment for the param. | +| - [options](#params_items_options ) | No | array | No | - | Options for a select or multiSelect type param. | + +#### 17.1.1. Property `root > params > params items > param` | | | | ------------ | -------- | @@ -701,15 +544,7 @@ **Description:** The name of the param. This is how you reference the param in your code -
-
- -
- - 17.1.2. [Optional] Property root > params > params items > label - - -
+#### 17.1.2. Property `root > params > params items > label` | | | | ------------ | -------- | @@ -718,15 +553,7 @@ **Description:** Short description for the parameter. Displayed to users when they're prompted for the parameter's value. -
-
- -
- - 17.1.3. [Optional] Property root > params > params items > description - - -
+#### 17.1.3. Property `root > params > params items > description` | | | | ------------ | -------- | @@ -735,15 +562,7 @@ **Description:** Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value. -
-
- -
- - 17.1.4. [Optional] Property root > params > params items > example - - -
+#### 17.1.4. Property `root > params > params items > example` | | | | ------------ | -------- | @@ -752,15 +571,7 @@ **Description:** Example value for the parameter. -
-
- -
- - 17.1.5. [Optional] Property root > params > params items > validationRegex - - -
+#### 17.1.5. Property `root > params > params items > validationRegex` | | | | ------------ | -------- | @@ -769,15 +580,7 @@ **Description:** Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax. -
-
- -
- - 17.1.6. [Optional] Property root > params > params items > validationErrorMessage - - -
+#### 17.1.6. Property `root > params > params items > validationErrorMessage` | | | | ------------ | -------- | @@ -786,15 +589,7 @@ **Description:** Error message to display if regex validation fails. -
-
- -
- - 17.1.7. [Optional] Property root > params > params items > default - - -
+#### 17.1.7. Property `root > params > params items > default` | | | | ------------ | -------- | @@ -803,15 +598,7 @@ **Description:** Default value for the parameter if the user leaves the parameter's value blank. -
-
- -
- - 17.1.8. [Optional] Property root > params > params items > required - - -
+#### 17.1.8. Property `root > params > params items > required` | | | | ------------ | --------- | @@ -820,15 +607,7 @@ **Description:** Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true. -
-
- -
- - 17.1.9. [Optional] Property root > params > params items > immutable - - -
+#### 17.1.9. Property `root > params > params items > immutable` | | | | ------------ | --------- | @@ -837,15 +616,7 @@ **Description:** Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false. -
-
- -
- - 17.1.10. [Optional] Property root > params > params items > advanced - - -
+#### 17.1.10. Property `root > params > params items > advanced` | | | | ------------ | --------- | @@ -854,15 +625,7 @@ **Description:** Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param. -
-
- -
- - 17.1.11. [Optional] Property root > params > params items > type - - -
+#### 17.1.11. Property `root > params > params items > type` | | | | ------------ | -------- | @@ -875,15 +638,7 @@ | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```string\|select\|multiSelect\|secret\|selectResource``` [Test](https://regex101.com/?regex=string%7Cselect%7CmultiSelect%7Csecret%7CselectResource) | -
-
- -
- - 17.1.12. [Optional] Property root > params > params items > resourceType - - -
+#### 17.1.12. Property `root > params > params items > resourceType` | | | | ------------ | -------- | @@ -896,15 +651,7 @@ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```storage\.googleapis\.com\/Bucket\|firestore\.googleapis\.com\/Database\|firebasedatabase\.googleapis\.com\/DatabaseInstance``` [Test](https://regex101.com/?regex=storage%5C.googleapis%5C.com%5C%2FBucket%7Cfirestore%5C.googleapis%5C.com%5C%2FDatabase%7Cfirebasedatabase%5C.googleapis%5C.com%5C%2FDatabaseInstance) | -
-
- -
- - 17.1.13. [Optional] Property root > params > params items > options - - -
+#### 17.1.13. Property `root > params > params items > options` | | | | ------------ | ------- | @@ -925,7 +672,7 @@ | ------------------------------------------ | ----------- | | [paramOption](#params_items_options_items) | - | -##### 17.1.13.1. root > params > params items > options > paramOption +##### 17.1.13.1. root > params > params items > options > paramOption | | | | ------------------------- | ------------------------- | @@ -934,12 +681,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/paramOption | -
- - 17.1.13.1.1. [Required] Property root > params > params items > options > options items > value +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- | +| + [value](#params_items_options_items_value ) | No | string | No | - | One of the values the user can choose. This is the value you get when you read the parameter value in code. | +| - [label](#params_items_options_items_label ) | No | string | No | - | Short description of the selectable option. If omitted, defaults to value. | - -
+###### 17.1.13.1.1. Property `root > params > params items > options > options items > value` | | | | ------------ | -------- | @@ -948,15 +695,7 @@ **Description:** One of the values the user can choose. This is the value you get when you read the parameter value in code. -
-
- -
- - 17.1.13.1.2. [Optional] Property root > params > params items > options > options items > label - - -
+###### 17.1.13.1.2. Property `root > params > params items > options > options items > label` | | | | ------------ | -------- | @@ -965,21 +704,7 @@ **Description:** Short description of the selectable option. If omitted, defaults to value. -
-
- -
-
- -
-
- -
- - 18. [Optional] Property root > resources - - -
+## 18. Property `root > resources` | | | | ------------ | ------- | @@ -998,7 +723,7 @@ | ------------------------------- | ----------- | | [resource](#resources_items) | - | -### 18.1. root > resources > resource +### 18.1. root > resources > resource | | | | ------------------------- | ---------------------- | @@ -1007,12 +732,14 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/resource | -
- - 18.1.1. [Required] Property root > resources > resources items > name +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| + [name](#resources_items_name ) | No | string | No | - | The name of this resource | +| + [type](#resources_items_type ) | No | string | No | - | What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options. | +| + [description](#resources_items_description ) | No | string | No | - | A brief description of what this resource does | +| + [properties](#resources_items_properties ) | No | object | No | - | The properties of this resource | - -
+#### 18.1.1. Property `root > resources > resources items > name` | | | | ------------ | -------- | @@ -1021,15 +748,7 @@ **Description:** The name of this resource -
-
- -
- - 18.1.2. [Required] Property root > resources > resources items > type - - -
+#### 18.1.2. Property `root > resources > resources items > type` | | | | ------------ | -------- | @@ -1038,15 +757,7 @@ **Description:** What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options. -
-
- -
- - 18.1.3. [Required] Property root > resources > resources items > description - - -
+#### 18.1.3. Property `root > resources > resources items > description` | | | | ------------ | -------- | @@ -1055,15 +766,7 @@ **Description:** A brief description of what this resource does -
-
- -
- - 18.1.4. [Required] Property root > resources > resources items > properties - - -
+#### 18.1.4. Property `root > resources > resources items > properties` | | | | ------------------------- | ---------------- | @@ -1073,12 +776,23 @@ **Description:** The properties of this resource -
- - 18.1.4.1. [Optional] Property root > resources > resources items > properties > location - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| - [location](#resources_items_properties_location ) | No | string | No | - | The location for this resource | +| - [entryPoint](#resources_items_properties_entryPoint ) | No | string | No | - | The entry point for a function resource | +| - [sourceDirectory](#resources_items_properties_sourceDirectory ) | No | string | No | - | Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions | +| - [timeout](#resources_items_properties_timeout ) | No | string | No | - | A function resources's maximum execution time. | +| - [availableMemoryMb](#resources_items_properties_availableMemoryMb ) | No | string | No | - | Amount of memory in MB available for the function. | +| - [runtime](#resources_items_properties_runtime ) | No | string | No | - | Runtime environment for the function. Defaults to the most recent LTS version of node. | +| - [httpsTrigger](#resources_items_properties_httpsTrigger ) | No | object | No | - | A function triggered by HTTPS calls | +| - [eventTrigger](#resources_items_properties_eventTrigger ) | No | object | No | - | A function triggered by a background event | +| - [scheduleTrigger](#resources_items_properties_scheduleTrigger ) | No | object | No | - | A function triggered at a regular interval by a Cloud Scheduler job | +| - [taskQueueTrigger](#resources_items_properties_taskQueueTrigger ) | No | object | No | - | A function triggered by a Cloud Task | +| - [buildConfig](#resources_items_properties_buildConfig ) | No | object | No | - | Build configuration for a gen 2 Cloud Function | +| - [serviceConfig](#resources_items_properties_serviceConfig ) | No | object | No | - | Service configuration for a gen 2 Cloud Function | +| - [](#resources_items_properties_additionalProperties ) | No | object | No | - | - | + +##### 18.1.4.1. Property `root > resources > resources items > properties > location` | | | | ------------ | -------- | @@ -1087,15 +801,7 @@ **Description:** The location for this resource -
-
- -
- - 18.1.4.2. [Optional] Property root > resources > resources items > properties > entryPoint - - -
+##### 18.1.4.2. Property `root > resources > resources items > properties > entryPoint` | | | | ------------ | -------- | @@ -1104,15 +810,7 @@ **Description:** The entry point for a function resource -
-
- -
- - 18.1.4.3. [Optional] Property root > resources > resources items > properties > sourceDirectory - - -
+##### 18.1.4.3. Property `root > resources > resources items > properties > sourceDirectory` | | | | ------------ | -------- | @@ -1121,15 +819,7 @@ **Description:** Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions -
-
- -
- - 18.1.4.4. [Optional] Property root > resources > resources items > properties > timeout - - -
+##### 18.1.4.4. Property `root > resources > resources items > properties > timeout` | | | | ------------ | -------- | @@ -1142,15 +832,7 @@ | --------------------------------- | ------------------------------------------------------- | | **Must match regular expression** | ```\d+s``` [Test](https://regex101.com/?regex=%5Cd%2Bs) | -
-
- -
- - 18.1.4.5. [Optional] Property root > resources > resources items > properties > availableMemoryMb - - -
+##### 18.1.4.5. Property `root > resources > resources items > properties > availableMemoryMb` | | | | ------------ | -------- | @@ -1163,15 +845,7 @@ | --------------------------------- | ----------------------------------------------------- | | **Must match regular expression** | ```\d+``` [Test](https://regex101.com/?regex=%5Cd%2B) | -
-
- -
- - 18.1.4.6. [Optional] Property root > resources > resources items > properties > runtime - - -
+##### 18.1.4.6. Property `root > resources > resources items > properties > runtime` | | | | ------------ | -------- | @@ -1180,15 +854,7 @@ **Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. -
-
- -
- - 18.1.4.7. [Optional] Property root > resources > resources items > properties > httpsTrigger - - -
+##### 18.1.4.7. Property `root > resources > resources items > properties > httpsTrigger` | | | | ------------------------- | ---------------- | @@ -1198,15 +864,7 @@ **Description:** A function triggered by HTTPS calls -
-
- -
- - 18.1.4.8. [Optional] Property root > resources > resources items > properties > eventTrigger - - -
+##### 18.1.4.8. Property `root > resources > resources items > properties > eventTrigger` | | | | ------------------------- | ---------------- | @@ -1216,12 +874,15 @@ **Description:** A function triggered by a background event -
- - 18.1.4.8.1. [Required] Property root > resources > resources items > properties > eventTrigger > eventType +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [eventType](#resources_items_properties_eventTrigger_eventType ) | No | string | No | - | The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list. | +| - [resource](#resources_items_properties_eventTrigger_resource ) | No | string | No | - | The name or pattern of the resource to trigger on | +| - [eventFilters](#resources_items_properties_eventTrigger_eventFilters ) | No | array | No | - | Filters that further limit the events to listen to. | +| - [channel](#resources_items_properties_eventTrigger_channel ) | No | string | No | - | The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel. | +| - [triggerRegion](#resources_items_properties_eventTrigger_triggerRegion ) | No | string | No | - | The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function. | - -
+###### 18.1.4.8.1. Property `root > resources > resources items > properties > eventTrigger > eventType` | | | | ------------ | -------- | @@ -1230,15 +891,7 @@ **Description:** The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list. -
-
- -
- - 18.1.4.8.2. [Optional] Property root > resources > resources items > properties > eventTrigger > resource - - -
+###### 18.1.4.8.2. Property `root > resources > resources items > properties > eventTrigger > resource` | | | | ------------ | -------- | @@ -1247,15 +900,7 @@ **Description:** The name or pattern of the resource to trigger on -
-
- -
- - 18.1.4.8.3. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters - - -
+###### 18.1.4.8.3. Property `root > resources > resources items > properties > eventTrigger > eventFilters` | | | | ------------ | ------- | @@ -1276,7 +921,7 @@ | -------------------------------------------------------------------------- | ----------- | | [eventFilter](#resources_items_properties_eventTrigger_eventFilters_items) | - | -###### 18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter +###### 18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter | | | | ------------------------- | ------------------------- | @@ -1285,12 +930,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/eventFilter | -
- - 18.1.4.8.3.1.1. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------- | +| - [attribute](#resources_items_properties_eventTrigger_eventFilters_items_attribute ) | No | string | No | - | The event attribute to filter on | +| - [value](#resources_items_properties_eventTrigger_eventFilters_items_value ) | No | string | No | - | The value to filter for | - -
+###### 18.1.4.8.3.1.1. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute` | | | | ------------ | -------- | @@ -1299,15 +944,7 @@ **Description:** The event attribute to filter on -
-
- -
- - 18.1.4.8.3.1.2. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value - - -
+###### 18.1.4.8.3.1.2. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value` | | | | ------------ | -------- | @@ -1316,18 +953,7 @@ **Description:** The value to filter for -
-
- -
-
- -
- - 18.1.4.8.4. [Optional] Property root > resources > resources items > properties > eventTrigger > channel - - -
+###### 18.1.4.8.4. Property `root > resources > resources items > properties > eventTrigger > channel` | | | | ------------ | -------- | @@ -1336,15 +962,7 @@ **Description:** The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel. -
-
- -
- - 18.1.4.8.5. [Optional] Property root > resources > resources items > properties > eventTrigger > triggerRegion - - -
+###### 18.1.4.8.5. Property `root > resources > resources items > properties > eventTrigger > triggerRegion` | | | | ------------ | -------- | @@ -1353,18 +971,7 @@ **Description:** The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function. -
-
- -
-
- -
- - 18.1.4.9. [Optional] Property root > resources > resources items > properties > scheduleTrigger - - -
+##### 18.1.4.9. Property `root > resources > resources items > properties > scheduleTrigger` | | | | ------------------------- | ---------------- | @@ -1374,12 +981,12 @@ **Description:** A function triggered at a regular interval by a Cloud Scheduler job -
- - 18.1.4.9.1. [Required] Property root > resources > resources items > properties > scheduleTrigger > schedule +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [schedule](#resources_items_properties_scheduleTrigger_schedule ) | No | string | No | - | The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax. | +| - [timeZone](#resources_items_properties_scheduleTrigger_timeZone ) | No | string | No | - | The time zone in which the schedule will run. Defaults to UTC. | - -
+###### 18.1.4.9.1. Property `root > resources > resources items > properties > scheduleTrigger > schedule` | | | | ------------ | -------- | @@ -1388,15 +995,7 @@ **Description:** The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax. -
-
- -
- - 18.1.4.9.2. [Optional] Property root > resources > resources items > properties > scheduleTrigger > timeZone - - -
+###### 18.1.4.9.2. Property `root > resources > resources items > properties > scheduleTrigger > timeZone` | | | | ------------ | -------- | @@ -1405,18 +1004,7 @@ **Description:** The time zone in which the schedule will run. Defaults to UTC. -
-
- -
-
- -
- - 18.1.4.10. [Optional] Property root > resources > resources items > properties > taskQueueTrigger - - -
+##### 18.1.4.10. Property `root > resources > resources items > properties > taskQueueTrigger` | | | | ------------------------- | ---------------- | @@ -1426,15 +1014,7 @@ **Description:** A function triggered by a Cloud Task -
-
- -
- - 18.1.4.11. [Optional] Property root > resources > resources items > properties > buildConfig - - -
+##### 18.1.4.11. Property `root > resources > resources items > properties > buildConfig` | | | | ------------------------- | ---------------- | @@ -1444,12 +1024,12 @@ **Description:** Build configuration for a gen 2 Cloud Function -
- - 18.1.4.11.1. [Optional] Property root > resources > resources items > properties > buildConfig > runtime +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------- | +| - [runtime](#resources_items_properties_buildConfig_runtime ) | No | string | No | - | Runtime environment for the function. Defaults to the most recent LTS version of node. | +| - [entryPoint](#resources_items_properties_buildConfig_entryPoint ) | No | string | No | - | The entry point for a function resource | - -
+###### 18.1.4.11.1. Property `root > resources > resources items > properties > buildConfig > runtime` | | | | ------------ | -------- | @@ -1458,15 +1038,7 @@ **Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. -
-
- -
- - 18.1.4.11.2. [Optional] Property root > resources > resources items > properties > buildConfig > entryPoint - - -
+###### 18.1.4.11.2. Property `root > resources > resources items > properties > buildConfig > entryPoint` | | | | ------------ | -------- | @@ -1475,18 +1047,7 @@ **Description:** The entry point for a function resource -
-
- -
-
- -
- - 18.1.4.12. [Optional] Property root > resources > resources items > properties > serviceConfig - - -
+##### 18.1.4.12. Property `root > resources > resources items > properties > serviceConfig` | | | | ------------------------- | ---------------- | @@ -1496,12 +1057,12 @@ **Description:** Service configuration for a gen 2 Cloud Function -
- - 18.1.4.12.1. [Optional] Property root > resources > resources items > properties > serviceConfig > timeoutSeconds +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [timeoutSeconds](#resources_items_properties_serviceConfig_timeoutSeconds ) | No | string | No | - | The function's maximum execution time. Default: 60, max value: 540. | +| - [availableMemory](#resources_items_properties_serviceConfig_availableMemory ) | No | string | No | - | The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes. | - -
+###### 18.1.4.12.1. Property `root > resources > resources items > properties > serviceConfig > timeoutSeconds` | | | | ------------ | -------- | @@ -1510,15 +1071,7 @@ **Description:** The function's maximum execution time. Default: 60, max value: 540. -
-
- -
- - 18.1.4.12.2. [Optional] Property root > resources > resources items > properties > serviceConfig > availableMemory - - -
+###### 18.1.4.12.2. Property `root > resources > resources items > properties > serviceConfig > availableMemory` | | | | ------------ | -------- | @@ -1527,24 +1080,7 @@ **Description:** The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes. -
-
- -
-
- -
-
- -
-
- -
- - 19. [Optional] Property root > lifecycleEvents - - -
+## 19. Property `root > lifecycleEvents` | | | | ------------ | ------- | @@ -1563,7 +1099,7 @@ | ---------------------------------------- | ----------- | | [lifecycleEvent](#lifecycleEvents_items) | - | -### 19.1. root > lifecycleEvents > lifecycleEvent +### 19.1. root > lifecycleEvents > lifecycleEvent | | | | ------------------------- | ---------------------------- | @@ -1572,12 +1108,13 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/lifecycleEvent | -
- - 19.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------ | ----------------- | +| - [onInstall](#lifecycleEvents_items_onInstall ) | No | object | No | In #/definitions/lifecycleEventSpec | - | +| - [onUpdate](#lifecycleEvents_items_onUpdate ) | No | object | No | Same as [onInstall](#lifecycleEvents_items_onInstall ) | - | +| - [onConfigure](#lifecycleEvents_items_onConfigure ) | No | object | No | Same as [onInstall](#lifecycleEvents_items_onInstall ) | - | - -
+#### 19.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall` | | | | ------------------------- | -------------------------------- | @@ -1586,12 +1123,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/lifecycleEventSpec | -
- - 19.1.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| - [function](#lifecycleEvents_items_onInstall_function ) | No | string | No | - | Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section. | +| - [processingMessage](#lifecycleEvents_items_onInstall_processingMessage ) | No | string | No | - | Message to display in the Firebase console while the task is in progress. | - -
+##### 19.1.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > function` | | | | ------------ | -------- | @@ -1600,15 +1137,7 @@ **Description:** Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section. -
-
- -
- - 19.1.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage - - -
+##### 19.1.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage` | | | | ------------ | -------- | @@ -1617,18 +1146,7 @@ **Description:** Message to display in the Firebase console while the task is in progress. -
-
- -
-
- -
- - 19.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onUpdate - - -
+#### 19.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onUpdate` | | | | ------------------------- | --------------------------------------------- | @@ -1637,15 +1155,7 @@ | **Additional properties** | Not allowed | | **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | -
-
- -
- - 19.1.3. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onConfigure - - -
+#### 19.1.3. Property `root > lifecycleEvents > lifecycleEvents items > onConfigure` | | | | ------------------------- | --------------------------------------------- | @@ -1654,18 +1164,7 @@ | **Additional properties** | Not allowed | | **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | -
-
- -
-
- -
- - 20. [Optional] Property root > events - - -
+## 20. Property `root > events` | | | | ------------ | ------- | @@ -1684,7 +1183,7 @@ | ------------------------------- | ----------- | | [event](#events_items) | - | -### 20.1. root > events > event +### 20.1. root > events > event | | | | ------------------------- | ------------------- | @@ -1693,12 +1192,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/event | -
- - 20.1.1. [Optional] Property root > events > events items > type +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [type](#events_items_type ) | No | string | No | - | The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish. | +| - [description](#events_items_description ) | No | string | No | - | A description of the event | - -
+#### 20.1.1. Property `root > events > events items > type` | | | | ------------ | -------- | @@ -1707,15 +1206,7 @@ **Description:** The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish. -
-
- -
- - 20.1.2. [Optional] Property root > events > events items > description - - -
+#### 20.1.2. Property `root > events > events items > description` | | | | ------------ | -------- | @@ -1724,11 +1215,5 @@ **Description:** A description of the event -
-
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md index cf8e8dd1d25..95ba3d6da3e 100644 --- a/schema/docs/firebase-config.md +++ b/schema/docs/firebase-config.md @@ -1,416 +1,416 @@ # Schema Docs -- [1. [Optional] Property root > $schema](#schema) -- [2. [Optional] Property root > apphosting](#apphosting) +- [1. Property `root > $schema`](#schema) +- [2. Property `root > apphosting`](#apphosting) - [2.1. Property `root > apphosting > anyOf > item 0`](#apphosting_anyOf_i0) - - [2.1.1. [Optional] Property root > apphosting > anyOf > item 0 > alwaysDeployFromSource](#apphosting_anyOf_i0_alwaysDeployFromSource) - - [2.1.2. [Required] Property root > apphosting > anyOf > item 0 > backendId](#apphosting_anyOf_i0_backendId) - - [2.1.3. [Required] Property root > apphosting > anyOf > item 0 > ignore](#apphosting_anyOf_i0_ignore) - - [2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_2) - - [2.1.4. [Required] Property root > apphosting > anyOf > item 0 > rootDir](#apphosting_anyOf_i0_rootDir) + - [2.1.1. Property `root > apphosting > anyOf > item 0 > alwaysDeployFromSource`](#apphosting_anyOf_i0_alwaysDeployFromSource) + - [2.1.2. Property `root > apphosting > anyOf > item 0 > backendId`](#apphosting_anyOf_i0_backendId) + - [2.1.3. Property `root > apphosting > anyOf > item 0 > ignore`](#apphosting_anyOf_i0_ignore) + - [2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items](#apphosting_anyOf_i0_ignore_items) + - [2.1.4. Property `root > apphosting > anyOf > item 0 > rootDir`](#apphosting_anyOf_i0_rootDir) - [2.2. Property `root > apphosting > anyOf > item 1`](#apphosting_anyOf_i1) - - [2.2.1. root > apphosting > anyOf > item 1 > item 1 items](#autogenerated_heading_3) - - [2.2.1.1. [Optional] Property root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource](#apphosting_anyOf_i1_items_alwaysDeployFromSource) - - [2.2.1.2. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > backendId](#apphosting_anyOf_i1_items_backendId) - - [2.2.1.3. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > ignore](#apphosting_anyOf_i1_items_ignore) - - [2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items](#autogenerated_heading_4) - - [2.2.1.4. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > rootDir](#apphosting_anyOf_i1_items_rootDir) -- [3. [Optional] Property root > database](#database) + - [2.2.1. root > apphosting > anyOf > item 1 > item 1 items](#apphosting_anyOf_i1_items) + - [2.2.1.1. Property `root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource`](#apphosting_anyOf_i1_items_alwaysDeployFromSource) + - [2.2.1.2. Property `root > apphosting > anyOf > item 1 > item 1 items > backendId`](#apphosting_anyOf_i1_items_backendId) + - [2.2.1.3. Property `root > apphosting > anyOf > item 1 > item 1 items > ignore`](#apphosting_anyOf_i1_items_ignore) + - [2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items](#apphosting_anyOf_i1_items_ignore_items) + - [2.2.1.4. Property `root > apphosting > anyOf > item 1 > item 1 items > rootDir`](#apphosting_anyOf_i1_items_rootDir) +- [3. Property `root > database`](#database) - [3.1. Property `root > database > anyOf > DatabaseSingle`](#database_anyOf_i0) - - [3.1.1. [Optional] Property root > database > anyOf > item 0 > postdeploy](#database_anyOf_i0_postdeploy) + - [3.1.1. Property `root > database > anyOf > item 0 > postdeploy`](#database_anyOf_i0_postdeploy) - [3.1.1.1. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 0`](#database_anyOf_i0_postdeploy_anyOf_i0) - - [3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_5) + - [3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#database_anyOf_i0_postdeploy_anyOf_i0_items) - [3.1.1.2. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 1`](#database_anyOf_i0_postdeploy_anyOf_i1) - - [3.1.2. [Optional] Property root > database > anyOf > item 0 > predeploy](#database_anyOf_i0_predeploy) + - [3.1.2. Property `root > database > anyOf > item 0 > predeploy`](#database_anyOf_i0_predeploy) - [3.1.2.1. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 0`](#database_anyOf_i0_predeploy_anyOf_i0) - - [3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_6) + - [3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#database_anyOf_i0_predeploy_anyOf_i0_items) - [3.1.2.2. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 1`](#database_anyOf_i0_predeploy_anyOf_i1) - - [3.1.3. [Required] Property root > database > anyOf > item 0 > rules](#database_anyOf_i0_rules) + - [3.1.3. Property `root > database > anyOf > item 0 > rules`](#database_anyOf_i0_rules) - [3.2. Property `root > database > anyOf > item 1`](#database_anyOf_i1) - - [3.2.1. root > database > anyOf > item 1 > item 1 items](#autogenerated_heading_7) + - [3.2.1. root > database > anyOf > item 1 > item 1 items](#database_anyOf_i1_items) - [3.2.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0) - - [3.2.1.1.1. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance](#database_anyOf_i1_items_anyOf_i0_instance) - - [3.2.1.1.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy](#database_anyOf_i1_items_anyOf_i0_postdeploy) + - [3.2.1.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance`](#database_anyOf_i1_items_anyOf_i0_instance) + - [3.2.1.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy`](#database_anyOf_i1_items_anyOf_i0_postdeploy) - [3.2.1.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) - - [3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_8) + - [3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) - [3.2.1.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) - - [3.2.1.1.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy](#database_anyOf_i1_items_anyOf_i0_predeploy) + - [3.2.1.1.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy`](#database_anyOf_i1_items_anyOf_i0_predeploy) - [3.2.1.1.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) - - [3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_9) + - [3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) - [3.2.1.1.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) - - [3.2.1.1.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules](#database_anyOf_i1_items_anyOf_i0_rules) - - [3.2.1.1.5. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target](#database_anyOf_i1_items_anyOf_i0_target) + - [3.2.1.1.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules`](#database_anyOf_i1_items_anyOf_i0_rules) + - [3.2.1.1.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target`](#database_anyOf_i1_items_anyOf_i0_target) - [3.2.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1) - - [3.2.1.2.1. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance](#database_anyOf_i1_items_anyOf_i1_instance) - - [3.2.1.2.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy](#database_anyOf_i1_items_anyOf_i1_postdeploy) + - [3.2.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance`](#database_anyOf_i1_items_anyOf_i1_instance) + - [3.2.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy`](#database_anyOf_i1_items_anyOf_i1_postdeploy) - [3.2.1.2.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) - - [3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_10) + - [3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) - [3.2.1.2.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) - - [3.2.1.2.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy](#database_anyOf_i1_items_anyOf_i1_predeploy) + - [3.2.1.2.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy`](#database_anyOf_i1_items_anyOf_i1_predeploy) - [3.2.1.2.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) - - [3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_11) + - [3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) - [3.2.1.2.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) - - [3.2.1.2.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules](#database_anyOf_i1_items_anyOf_i1_rules) - - [3.2.1.2.5. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target](#database_anyOf_i1_items_anyOf_i1_target) -- [4. [Optional] Property root > dataconnect](#dataconnect) + - [3.2.1.2.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules`](#database_anyOf_i1_items_anyOf_i1_rules) + - [3.2.1.2.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target`](#database_anyOf_i1_items_anyOf_i1_target) +- [4. Property `root > dataconnect`](#dataconnect) - [4.1. Property `root > dataconnect > anyOf > DataConnectSingle`](#dataconnect_anyOf_i0) - - [4.1.1. [Optional] Property root > dataconnect > anyOf > item 0 > postdeploy](#dataconnect_anyOf_i0_postdeploy) + - [4.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy`](#dataconnect_anyOf_i0_postdeploy) - [4.1.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0`](#dataconnect_anyOf_i0_postdeploy_anyOf_i0) - - [4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_12) + - [4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#dataconnect_anyOf_i0_postdeploy_anyOf_i0_items) - [4.1.1.2. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 1`](#dataconnect_anyOf_i0_postdeploy_anyOf_i1) - - [4.1.2. [Optional] Property root > dataconnect > anyOf > item 0 > predeploy](#dataconnect_anyOf_i0_predeploy) + - [4.1.2. Property `root > dataconnect > anyOf > item 0 > predeploy`](#dataconnect_anyOf_i0_predeploy) - [4.1.2.1. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0`](#dataconnect_anyOf_i0_predeploy_anyOf_i0) - - [4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_13) + - [4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#dataconnect_anyOf_i0_predeploy_anyOf_i0_items) - [4.1.2.2. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 1`](#dataconnect_anyOf_i0_predeploy_anyOf_i1) - - [4.1.3. [Required] Property root > dataconnect > anyOf > item 0 > source](#dataconnect_anyOf_i0_source) + - [4.1.3. Property `root > dataconnect > anyOf > item 0 > source`](#dataconnect_anyOf_i0_source) - [4.2. Property `root > dataconnect > anyOf > item 1`](#dataconnect_anyOf_i1) - - [4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle](#autogenerated_heading_14) -- [5. [Optional] Property root > emulators](#emulators) - - [5.1. [Optional] Property root > emulators > apphosting](#emulators_apphosting) - - [5.1.1. [Optional] Property root > emulators > apphosting > host](#emulators_apphosting_host) - - [5.1.2. [Optional] Property root > emulators > apphosting > port](#emulators_apphosting_port) - - [5.1.3. [Optional] Property root > emulators > apphosting > rootDirectory](#emulators_apphosting_rootDirectory) - - [5.1.4. [Optional] Property root > emulators > apphosting > startCommand](#emulators_apphosting_startCommand) - - [5.1.5. [Optional] Property root > emulators > apphosting > startCommandOverride](#emulators_apphosting_startCommandOverride) - - [5.2. [Optional] Property root > emulators > auth](#emulators_auth) - - [5.2.1. [Optional] Property root > emulators > auth > host](#emulators_auth_host) - - [5.2.2. [Optional] Property root > emulators > auth > port](#emulators_auth_port) - - [5.3. [Optional] Property root > emulators > database](#emulators_database) - - [5.3.1. [Optional] Property root > emulators > database > host](#emulators_database_host) - - [5.3.2. [Optional] Property root > emulators > database > port](#emulators_database_port) - - [5.4. [Optional] Property root > emulators > dataconnect](#emulators_dataconnect) - - [5.4.1. [Optional] Property root > emulators > dataconnect > dataDir](#emulators_dataconnect_dataDir) - - [5.4.2. [Optional] Property root > emulators > dataconnect > host](#emulators_dataconnect_host) - - [5.4.3. [Optional] Property root > emulators > dataconnect > port](#emulators_dataconnect_port) - - [5.4.4. [Optional] Property root > emulators > dataconnect > postgresHost](#emulators_dataconnect_postgresHost) - - [5.4.5. [Optional] Property root > emulators > dataconnect > postgresPort](#emulators_dataconnect_postgresPort) - - [5.5. [Optional] Property root > emulators > eventarc](#emulators_eventarc) - - [5.5.1. [Optional] Property root > emulators > eventarc > host](#emulators_eventarc_host) - - [5.5.2. [Optional] Property root > emulators > eventarc > port](#emulators_eventarc_port) - - [5.6. [Optional] Property root > emulators > extensions](#emulators_extensions) - - [5.7. [Optional] Property root > emulators > firestore](#emulators_firestore) - - [5.7.1. [Optional] Property root > emulators > firestore > host](#emulators_firestore_host) - - [5.7.2. [Optional] Property root > emulators > firestore > port](#emulators_firestore_port) - - [5.7.3. [Optional] Property root > emulators > firestore > websocketPort](#emulators_firestore_websocketPort) - - [5.8. [Optional] Property root > emulators > hosting](#emulators_hosting) - - [5.8.1. [Optional] Property root > emulators > hosting > host](#emulators_hosting_host) - - [5.8.2. [Optional] Property root > emulators > hosting > port](#emulators_hosting_port) - - [5.9. [Optional] Property root > emulators > hub](#emulators_hub) - - [5.9.1. [Optional] Property root > emulators > hub > host](#emulators_hub_host) - - [5.9.2. [Optional] Property root > emulators > hub > port](#emulators_hub_port) - - [5.10. [Optional] Property root > emulators > logging](#emulators_logging) - - [5.10.1. [Optional] Property root > emulators > logging > host](#emulators_logging_host) - - [5.10.2. [Optional] Property root > emulators > logging > port](#emulators_logging_port) - - [5.11. [Optional] Property root > emulators > pubsub](#emulators_pubsub) - - [5.11.1. [Optional] Property root > emulators > pubsub > host](#emulators_pubsub_host) - - [5.11.2. [Optional] Property root > emulators > pubsub > port](#emulators_pubsub_port) - - [5.12. [Optional] Property root > emulators > singleProjectMode](#emulators_singleProjectMode) - - [5.13. [Optional] Property root > emulators > storage](#emulators_storage) - - [5.13.1. [Optional] Property root > emulators > storage > host](#emulators_storage_host) - - [5.13.2. [Optional] Property root > emulators > storage > port](#emulators_storage_port) - - [5.14. [Optional] Property root > emulators > tasks](#emulators_tasks) - - [5.14.1. [Optional] Property root > emulators > tasks > host](#emulators_tasks_host) - - [5.14.2. [Optional] Property root > emulators > tasks > port](#emulators_tasks_port) - - [5.15. [Optional] Property root > emulators > ui](#emulators_ui) - - [5.15.1. [Optional] Property root > emulators > ui > enabled](#emulators_ui_enabled) - - [5.15.2. [Optional] Property root > emulators > ui > host](#emulators_ui_host) - - [5.15.3. [Optional] Property root > emulators > ui > port](#emulators_ui_port) -- [6. [Optional] Property root > extensions](#extensions) -- [7. [Optional] Property root > firestore](#firestore) + - [4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle](#dataconnect_anyOf_i1_items) +- [5. Property `root > emulators`](#emulators) + - [5.1. Property `root > emulators > apphosting`](#emulators_apphosting) + - [5.1.1. Property `root > emulators > apphosting > host`](#emulators_apphosting_host) + - [5.1.2. Property `root > emulators > apphosting > port`](#emulators_apphosting_port) + - [5.1.3. Property `root > emulators > apphosting > rootDirectory`](#emulators_apphosting_rootDirectory) + - [5.1.4. Property `root > emulators > apphosting > startCommand`](#emulators_apphosting_startCommand) + - [5.1.5. Property `root > emulators > apphosting > startCommandOverride`](#emulators_apphosting_startCommandOverride) + - [5.2. Property `root > emulators > auth`](#emulators_auth) + - [5.2.1. Property `root > emulators > auth > host`](#emulators_auth_host) + - [5.2.2. Property `root > emulators > auth > port`](#emulators_auth_port) + - [5.3. Property `root > emulators > database`](#emulators_database) + - [5.3.1. Property `root > emulators > database > host`](#emulators_database_host) + - [5.3.2. Property `root > emulators > database > port`](#emulators_database_port) + - [5.4. Property `root > emulators > dataconnect`](#emulators_dataconnect) + - [5.4.1. Property `root > emulators > dataconnect > dataDir`](#emulators_dataconnect_dataDir) + - [5.4.2. Property `root > emulators > dataconnect > host`](#emulators_dataconnect_host) + - [5.4.3. Property `root > emulators > dataconnect > port`](#emulators_dataconnect_port) + - [5.4.4. Property `root > emulators > dataconnect > postgresHost`](#emulators_dataconnect_postgresHost) + - [5.4.5. Property `root > emulators > dataconnect > postgresPort`](#emulators_dataconnect_postgresPort) + - [5.5. Property `root > emulators > eventarc`](#emulators_eventarc) + - [5.5.1. Property `root > emulators > eventarc > host`](#emulators_eventarc_host) + - [5.5.2. Property `root > emulators > eventarc > port`](#emulators_eventarc_port) + - [5.6. Property `root > emulators > extensions`](#emulators_extensions) + - [5.7. Property `root > emulators > firestore`](#emulators_firestore) + - [5.7.1. Property `root > emulators > firestore > host`](#emulators_firestore_host) + - [5.7.2. Property `root > emulators > firestore > port`](#emulators_firestore_port) + - [5.7.3. Property `root > emulators > firestore > websocketPort`](#emulators_firestore_websocketPort) + - [5.8. Property `root > emulators > hosting`](#emulators_hosting) + - [5.8.1. Property `root > emulators > hosting > host`](#emulators_hosting_host) + - [5.8.2. Property `root > emulators > hosting > port`](#emulators_hosting_port) + - [5.9. Property `root > emulators > hub`](#emulators_hub) + - [5.9.1. Property `root > emulators > hub > host`](#emulators_hub_host) + - [5.9.2. Property `root > emulators > hub > port`](#emulators_hub_port) + - [5.10. Property `root > emulators > logging`](#emulators_logging) + - [5.10.1. Property `root > emulators > logging > host`](#emulators_logging_host) + - [5.10.2. Property `root > emulators > logging > port`](#emulators_logging_port) + - [5.11. Property `root > emulators > pubsub`](#emulators_pubsub) + - [5.11.1. Property `root > emulators > pubsub > host`](#emulators_pubsub_host) + - [5.11.2. Property `root > emulators > pubsub > port`](#emulators_pubsub_port) + - [5.12. Property `root > emulators > singleProjectMode`](#emulators_singleProjectMode) + - [5.13. Property `root > emulators > storage`](#emulators_storage) + - [5.13.1. Property `root > emulators > storage > host`](#emulators_storage_host) + - [5.13.2. Property `root > emulators > storage > port`](#emulators_storage_port) + - [5.14. Property `root > emulators > tasks`](#emulators_tasks) + - [5.14.1. Property `root > emulators > tasks > host`](#emulators_tasks_host) + - [5.14.2. Property `root > emulators > tasks > port`](#emulators_tasks_port) + - [5.15. Property `root > emulators > ui`](#emulators_ui) + - [5.15.1. Property `root > emulators > ui > enabled`](#emulators_ui_enabled) + - [5.15.2. Property `root > emulators > ui > host`](#emulators_ui_host) + - [5.15.3. Property `root > emulators > ui > port`](#emulators_ui_port) +- [6. Property `root > extensions`](#extensions) +- [7. Property `root > firestore`](#firestore) - [7.1. Property `root > firestore > anyOf > FirestoreSingle`](#firestore_anyOf_i0) - - [7.1.1. [Optional] Property root > firestore > anyOf > item 0 > database](#firestore_anyOf_i0_database) - - [7.1.2. [Optional] Property root > firestore > anyOf > item 0 > indexes](#firestore_anyOf_i0_indexes) - - [7.1.3. [Optional] Property root > firestore > anyOf > item 0 > location](#firestore_anyOf_i0_location) - - [7.1.4. [Optional] Property root > firestore > anyOf > item 0 > postdeploy](#firestore_anyOf_i0_postdeploy) + - [7.1.1. Property `root > firestore > anyOf > item 0 > database`](#firestore_anyOf_i0_database) + - [7.1.2. Property `root > firestore > anyOf > item 0 > indexes`](#firestore_anyOf_i0_indexes) + - [7.1.3. Property `root > firestore > anyOf > item 0 > location`](#firestore_anyOf_i0_location) + - [7.1.4. Property `root > firestore > anyOf > item 0 > postdeploy`](#firestore_anyOf_i0_postdeploy) - [7.1.4.1. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0`](#firestore_anyOf_i0_postdeploy_anyOf_i0) - - [7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_15) + - [7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i0_postdeploy_anyOf_i0_items) - [7.1.4.2. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 1`](#firestore_anyOf_i0_postdeploy_anyOf_i1) - - [7.1.5. [Optional] Property root > firestore > anyOf > item 0 > predeploy](#firestore_anyOf_i0_predeploy) + - [7.1.5. Property `root > firestore > anyOf > item 0 > predeploy`](#firestore_anyOf_i0_predeploy) - [7.1.5.1. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 0`](#firestore_anyOf_i0_predeploy_anyOf_i0) - - [7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_16) + - [7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i0_predeploy_anyOf_i0_items) - [7.1.5.2. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 1`](#firestore_anyOf_i0_predeploy_anyOf_i1) - - [7.1.6. [Optional] Property root > firestore > anyOf > item 0 > rules](#firestore_anyOf_i0_rules) + - [7.1.6. Property `root > firestore > anyOf > item 0 > rules`](#firestore_anyOf_i0_rules) - [7.2. Property `root > firestore > anyOf > item 1`](#firestore_anyOf_i1) - - [7.2.1. root > firestore > anyOf > item 1 > item 1 items](#autogenerated_heading_17) + - [7.2.1. root > firestore > anyOf > item 1 > item 1 items](#firestore_anyOf_i1_items) - [7.2.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0) - - [7.2.1.1.1. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database](#firestore_anyOf_i1_items_anyOf_i0_database) - - [7.2.1.1.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes](#firestore_anyOf_i1_items_anyOf_i0_indexes) - - [7.2.1.1.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy](#firestore_anyOf_i1_items_anyOf_i0_postdeploy) + - [7.2.1.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database`](#firestore_anyOf_i1_items_anyOf_i0_database) + - [7.2.1.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes`](#firestore_anyOf_i1_items_anyOf_i0_indexes) + - [7.2.1.1.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy) - [7.2.1.1.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) - - [7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_18) + - [7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) - [7.2.1.1.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) - - [7.2.1.1.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy](#firestore_anyOf_i1_items_anyOf_i0_predeploy) + - [7.2.1.1.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy`](#firestore_anyOf_i1_items_anyOf_i0_predeploy) - [7.2.1.1.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) - - [7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_19) + - [7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) - [7.2.1.1.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) - - [7.2.1.1.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules](#firestore_anyOf_i1_items_anyOf_i0_rules) - - [7.2.1.1.6. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target](#firestore_anyOf_i1_items_anyOf_i0_target) + - [7.2.1.1.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules`](#firestore_anyOf_i1_items_anyOf_i0_rules) + - [7.2.1.1.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target`](#firestore_anyOf_i1_items_anyOf_i0_target) - [7.2.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1) - - [7.2.1.2.1. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database](#firestore_anyOf_i1_items_anyOf_i1_database) - - [7.2.1.2.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes](#firestore_anyOf_i1_items_anyOf_i1_indexes) - - [7.2.1.2.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy](#firestore_anyOf_i1_items_anyOf_i1_postdeploy) + - [7.2.1.2.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database`](#firestore_anyOf_i1_items_anyOf_i1_database) + - [7.2.1.2.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes`](#firestore_anyOf_i1_items_anyOf_i1_indexes) + - [7.2.1.2.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy) - [7.2.1.2.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) - - [7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_20) + - [7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) - [7.2.1.2.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) - - [7.2.1.2.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy](#firestore_anyOf_i1_items_anyOf_i1_predeploy) + - [7.2.1.2.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy`](#firestore_anyOf_i1_items_anyOf_i1_predeploy) - [7.2.1.2.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) - - [7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_21) + - [7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) - [7.2.1.2.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) - - [7.2.1.2.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules](#firestore_anyOf_i1_items_anyOf_i1_rules) - - [7.2.1.2.6. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target](#firestore_anyOf_i1_items_anyOf_i1_target) -- [8. [Optional] Property root > functions](#functions) + - [7.2.1.2.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules`](#firestore_anyOf_i1_items_anyOf_i1_rules) + - [7.2.1.2.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target`](#firestore_anyOf_i1_items_anyOf_i1_target) +- [8. Property `root > functions`](#functions) - [8.1. Property `root > functions > anyOf > FunctionConfig`](#functions_anyOf_i0) - - [8.1.1. [Optional] Property root > functions > anyOf > item 0 > codebase](#functions_anyOf_i0_codebase) - - [8.1.2. [Optional] Property root > functions > anyOf > item 0 > ignore](#functions_anyOf_i0_ignore) - - [8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_22) - - [8.1.3. [Optional] Property root > functions > anyOf > item 0 > postdeploy](#functions_anyOf_i0_postdeploy) + - [8.1.1. Property `root > functions > anyOf > item 0 > codebase`](#functions_anyOf_i0_codebase) + - [8.1.2. Property `root > functions > anyOf > item 0 > ignore`](#functions_anyOf_i0_ignore) + - [8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items](#functions_anyOf_i0_ignore_items) + - [8.1.3. Property `root > functions > anyOf > item 0 > postdeploy`](#functions_anyOf_i0_postdeploy) - [8.1.3.1. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 0`](#functions_anyOf_i0_postdeploy_anyOf_i0) - - [8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_23) + - [8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#functions_anyOf_i0_postdeploy_anyOf_i0_items) - [8.1.3.2. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 1`](#functions_anyOf_i0_postdeploy_anyOf_i1) - - [8.1.4. [Optional] Property root > functions > anyOf > item 0 > predeploy](#functions_anyOf_i0_predeploy) + - [8.1.4. Property `root > functions > anyOf > item 0 > predeploy`](#functions_anyOf_i0_predeploy) - [8.1.4.1. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 0`](#functions_anyOf_i0_predeploy_anyOf_i0) - - [8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_24) + - [8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#functions_anyOf_i0_predeploy_anyOf_i0_items) - [8.1.4.2. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 1`](#functions_anyOf_i0_predeploy_anyOf_i1) - - [8.1.5. [Optional] Property root > functions > anyOf > item 0 > runtime](#functions_anyOf_i0_runtime) - - [8.1.6. [Optional] Property root > functions > anyOf > item 0 > source](#functions_anyOf_i0_source) + - [8.1.5. Property `root > functions > anyOf > item 0 > runtime`](#functions_anyOf_i0_runtime) + - [8.1.6. Property `root > functions > anyOf > item 0 > source`](#functions_anyOf_i0_source) - [8.2. Property `root > functions > anyOf > item 1`](#functions_anyOf_i1) - - [8.2.1. root > functions > anyOf > item 1 > FunctionConfig](#autogenerated_heading_25) -- [9. [Optional] Property root > hosting](#hosting) + - [8.2.1. root > functions > anyOf > item 1 > FunctionConfig](#functions_anyOf_i1_items) +- [9. Property `root > hosting`](#hosting) - [9.1. Property `root > hosting > anyOf > HostingSingle`](#hosting_anyOf_i0) - - [9.1.1. [Optional] Property root > hosting > anyOf > item 0 > appAssociation](#hosting_anyOf_i0_appAssociation) - - [9.1.2. [Optional] Property root > hosting > anyOf > item 0 > cleanUrls](#hosting_anyOf_i0_cleanUrls) - - [9.1.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend](#hosting_anyOf_i0_frameworksBackend) - - [9.1.3.1. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > concurrency](#hosting_anyOf_i0_frameworksBackend_concurrency) - - [9.1.3.2. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cors](#hosting_anyOf_i0_frameworksBackend_cors) - - [9.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cpu](#hosting_anyOf_i0_frameworksBackend_cpu) + - [9.1.1. Property `root > hosting > anyOf > item 0 > appAssociation`](#hosting_anyOf_i0_appAssociation) + - [9.1.2. Property `root > hosting > anyOf > item 0 > cleanUrls`](#hosting_anyOf_i0_cleanUrls) + - [9.1.3. Property `root > hosting > anyOf > item 0 > frameworksBackend`](#hosting_anyOf_i0_frameworksBackend) + - [9.1.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > concurrency`](#hosting_anyOf_i0_frameworksBackend_concurrency) + - [9.1.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cors`](#hosting_anyOf_i0_frameworksBackend_cors) + - [9.1.3.3. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu`](#hosting_anyOf_i0_frameworksBackend_cpu) - [9.1.3.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 0`](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i0) - [9.1.3.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 1`](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i1) - - [9.1.3.4. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck](#hosting_anyOf_i0_frameworksBackend_enforceAppCheck) - - [9.1.3.5. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings](#hosting_anyOf_i0_frameworksBackend_ingressSettings) - - [9.1.3.6. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > invoker](#hosting_anyOf_i0_frameworksBackend_invoker) - - [9.1.3.7. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > labels](#hosting_anyOf_i0_frameworksBackend_labels) - - [9.1.3.8. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > maxInstances](#hosting_anyOf_i0_frameworksBackend_maxInstances) - - [9.1.3.9. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > memory](#hosting_anyOf_i0_frameworksBackend_memory) - - [9.1.3.10. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > minInstances](#hosting_anyOf_i0_frameworksBackend_minInstances) - - [9.1.3.11. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > omit](#hosting_anyOf_i0_frameworksBackend_omit) - - [9.1.3.12. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges](#hosting_anyOf_i0_frameworksBackend_preserveExternalChanges) - - [9.1.3.13. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > region](#hosting_anyOf_i0_frameworksBackend_region) - - [9.1.3.14. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > secrets](#hosting_anyOf_i0_frameworksBackend_secrets) - - [9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items](#autogenerated_heading_26) - - [9.1.3.15. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount](#hosting_anyOf_i0_frameworksBackend_serviceAccount) - - [9.1.3.16. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds](#hosting_anyOf_i0_frameworksBackend_timeoutSeconds) - - [9.1.3.17. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector](#hosting_anyOf_i0_frameworksBackend_vpcConnector) - - [9.1.3.18. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings](#hosting_anyOf_i0_frameworksBackend_vpcConnectorEgressSettings) - - [9.1.4. [Optional] Property root > hosting > anyOf > item 0 > headers](#hosting_anyOf_i0_headers) - - [9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders](#autogenerated_heading_27) + - [9.1.3.4. Property `root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck`](#hosting_anyOf_i0_frameworksBackend_enforceAppCheck) + - [9.1.3.5. Property `root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings`](#hosting_anyOf_i0_frameworksBackend_ingressSettings) + - [9.1.3.6. Property `root > hosting > anyOf > item 0 > frameworksBackend > invoker`](#hosting_anyOf_i0_frameworksBackend_invoker) + - [9.1.3.7. Property `root > hosting > anyOf > item 0 > frameworksBackend > labels`](#hosting_anyOf_i0_frameworksBackend_labels) + - [9.1.3.8. Property `root > hosting > anyOf > item 0 > frameworksBackend > maxInstances`](#hosting_anyOf_i0_frameworksBackend_maxInstances) + - [9.1.3.9. Property `root > hosting > anyOf > item 0 > frameworksBackend > memory`](#hosting_anyOf_i0_frameworksBackend_memory) + - [9.1.3.10. Property `root > hosting > anyOf > item 0 > frameworksBackend > minInstances`](#hosting_anyOf_i0_frameworksBackend_minInstances) + - [9.1.3.11. Property `root > hosting > anyOf > item 0 > frameworksBackend > omit`](#hosting_anyOf_i0_frameworksBackend_omit) + - [9.1.3.12. Property `root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges`](#hosting_anyOf_i0_frameworksBackend_preserveExternalChanges) + - [9.1.3.13. Property `root > hosting > anyOf > item 0 > frameworksBackend > region`](#hosting_anyOf_i0_frameworksBackend_region) + - [9.1.3.14. Property `root > hosting > anyOf > item 0 > frameworksBackend > secrets`](#hosting_anyOf_i0_frameworksBackend_secrets) + - [9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items](#hosting_anyOf_i0_frameworksBackend_secrets_items) + - [9.1.3.15. Property `root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount`](#hosting_anyOf_i0_frameworksBackend_serviceAccount) + - [9.1.3.16. Property `root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds`](#hosting_anyOf_i0_frameworksBackend_timeoutSeconds) + - [9.1.3.17. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector`](#hosting_anyOf_i0_frameworksBackend_vpcConnector) + - [9.1.3.18. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings`](#hosting_anyOf_i0_frameworksBackend_vpcConnectorEgressSettings) + - [9.1.4. Property `root > hosting > anyOf > item 0 > headers`](#hosting_anyOf_i0_headers) + - [9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders](#hosting_anyOf_i0_headers_items) - [9.1.4.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0`](#hosting_anyOf_i0_headers_items_anyOf_i0) - - [9.1.4.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob](#hosting_anyOf_i0_headers_items_anyOf_i0_glob) - - [9.1.4.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers](#hosting_anyOf_i0_headers_items_anyOf_i0_headers) - - [9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items](#autogenerated_heading_28) - - [9.1.4.1.1.2.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_key) - - [9.1.4.1.1.2.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_value) + - [9.1.4.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob`](#hosting_anyOf_i0_headers_items_anyOf_i0_glob) + - [9.1.4.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers`](#hosting_anyOf_i0_headers_items_anyOf_i0_headers) + - [9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items) + - [9.1.4.1.1.2.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key`](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_key) + - [9.1.4.1.1.2.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value`](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_value) - [9.1.4.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1`](#hosting_anyOf_i0_headers_items_anyOf_i1) - - [9.1.4.1.2.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers](#hosting_anyOf_i0_headers_items_anyOf_i1_headers) - - [9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items](#autogenerated_heading_29) - - [9.1.4.1.2.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_key) - - [9.1.4.1.2.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_value) - - [9.1.4.1.2.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source](#hosting_anyOf_i0_headers_items_anyOf_i1_source) + - [9.1.4.1.2.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers`](#hosting_anyOf_i0_headers_items_anyOf_i1_headers) + - [9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items) + - [9.1.4.1.2.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key`](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_key) + - [9.1.4.1.2.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value`](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_value) + - [9.1.4.1.2.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source`](#hosting_anyOf_i0_headers_items_anyOf_i1_source) - [9.1.4.1.3. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2`](#hosting_anyOf_i0_headers_items_anyOf_i2) - - [9.1.4.1.3.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers](#hosting_anyOf_i0_headers_items_anyOf_i2_headers) - - [9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items](#autogenerated_heading_30) - - [9.1.4.1.3.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_key) - - [9.1.4.1.3.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_value) - - [9.1.4.1.3.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex](#hosting_anyOf_i0_headers_items_anyOf_i2_regex) - - [9.1.5. [Optional] Property root > hosting > anyOf > item 0 > i18n](#hosting_anyOf_i0_i18n) - - [9.1.5.1. [Required] Property root > hosting > anyOf > item 0 > i18n > root](#hosting_anyOf_i0_i18n_root) - - [9.1.6. [Optional] Property root > hosting > anyOf > item 0 > ignore](#hosting_anyOf_i0_ignore) - - [9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_31) - - [9.1.7. [Optional] Property root > hosting > anyOf > item 0 > postdeploy](#hosting_anyOf_i0_postdeploy) + - [9.1.4.1.3.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers`](#hosting_anyOf_i0_headers_items_anyOf_i2_headers) + - [9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items) + - [9.1.4.1.3.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key`](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_key) + - [9.1.4.1.3.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value`](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_value) + - [9.1.4.1.3.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex`](#hosting_anyOf_i0_headers_items_anyOf_i2_regex) + - [9.1.5. Property `root > hosting > anyOf > item 0 > i18n`](#hosting_anyOf_i0_i18n) + - [9.1.5.1. Property `root > hosting > anyOf > item 0 > i18n > root`](#hosting_anyOf_i0_i18n_root) + - [9.1.6. Property `root > hosting > anyOf > item 0 > ignore`](#hosting_anyOf_i0_ignore) + - [9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items](#hosting_anyOf_i0_ignore_items) + - [9.1.7. Property `root > hosting > anyOf > item 0 > postdeploy`](#hosting_anyOf_i0_postdeploy) - [9.1.7.1. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0`](#hosting_anyOf_i0_postdeploy_anyOf_i0) - - [9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_32) + - [9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i0_postdeploy_anyOf_i0_items) - [9.1.7.2. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 1`](#hosting_anyOf_i0_postdeploy_anyOf_i1) - - [9.1.8. [Optional] Property root > hosting > anyOf > item 0 > predeploy](#hosting_anyOf_i0_predeploy) + - [9.1.8. Property `root > hosting > anyOf > item 0 > predeploy`](#hosting_anyOf_i0_predeploy) - [9.1.8.1. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 0`](#hosting_anyOf_i0_predeploy_anyOf_i0) - - [9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_33) + - [9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i0_predeploy_anyOf_i0_items) - [9.1.8.2. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 1`](#hosting_anyOf_i0_predeploy_anyOf_i1) - - [9.1.9. [Optional] Property root > hosting > anyOf > item 0 > public](#hosting_anyOf_i0_public) - - [9.1.10. [Optional] Property root > hosting > anyOf > item 0 > redirects](#hosting_anyOf_i0_redirects) - - [9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects](#autogenerated_heading_34) + - [9.1.9. Property `root > hosting > anyOf > item 0 > public`](#hosting_anyOf_i0_public) + - [9.1.10. Property `root > hosting > anyOf > item 0 > redirects`](#hosting_anyOf_i0_redirects) + - [9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects](#hosting_anyOf_i0_redirects_items) - [9.1.10.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0`](#hosting_anyOf_i0_redirects_items_anyOf_i0) - - [9.1.10.1.1.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination](#hosting_anyOf_i0_redirects_items_anyOf_i0_destination) - - [9.1.10.1.1.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob](#hosting_anyOf_i0_redirects_items_anyOf_i0_glob) - - [9.1.10.1.1.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type](#hosting_anyOf_i0_redirects_items_anyOf_i0_type) + - [9.1.10.1.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination`](#hosting_anyOf_i0_redirects_items_anyOf_i0_destination) + - [9.1.10.1.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob`](#hosting_anyOf_i0_redirects_items_anyOf_i0_glob) + - [9.1.10.1.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type`](#hosting_anyOf_i0_redirects_items_anyOf_i0_type) - [9.1.10.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1`](#hosting_anyOf_i0_redirects_items_anyOf_i1) - - [9.1.10.1.2.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination](#hosting_anyOf_i0_redirects_items_anyOf_i1_destination) - - [9.1.10.1.2.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source](#hosting_anyOf_i0_redirects_items_anyOf_i1_source) - - [9.1.10.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type](#hosting_anyOf_i0_redirects_items_anyOf_i1_type) + - [9.1.10.1.2.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination`](#hosting_anyOf_i0_redirects_items_anyOf_i1_destination) + - [9.1.10.1.2.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source`](#hosting_anyOf_i0_redirects_items_anyOf_i1_source) + - [9.1.10.1.2.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type`](#hosting_anyOf_i0_redirects_items_anyOf_i1_type) - [9.1.10.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2`](#hosting_anyOf_i0_redirects_items_anyOf_i2) - - [9.1.10.1.3.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination](#hosting_anyOf_i0_redirects_items_anyOf_i2_destination) - - [9.1.10.1.3.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex](#hosting_anyOf_i0_redirects_items_anyOf_i2_regex) - - [9.1.10.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type](#hosting_anyOf_i0_redirects_items_anyOf_i2_type) - - [9.1.11. [Optional] Property root > hosting > anyOf > item 0 > rewrites](#hosting_anyOf_i0_rewrites) - - [9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites](#autogenerated_heading_35) + - [9.1.10.1.3.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination`](#hosting_anyOf_i0_redirects_items_anyOf_i2_destination) + - [9.1.10.1.3.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex`](#hosting_anyOf_i0_redirects_items_anyOf_i2_regex) + - [9.1.10.1.3.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type`](#hosting_anyOf_i0_redirects_items_anyOf_i2_type) + - [9.1.11. Property `root > hosting > anyOf > item 0 > rewrites`](#hosting_anyOf_i0_rewrites) + - [9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites](#hosting_anyOf_i0_rewrites_items) - [9.1.11.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0`](#hosting_anyOf_i0_rewrites_items_anyOf_i0) - - [9.1.11.1.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination](#hosting_anyOf_i0_rewrites_items_anyOf_i0_destination) - - [9.1.11.1.1.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i0_glob) + - [9.1.11.1.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination`](#hosting_anyOf_i0_rewrites_items_anyOf_i0_destination) + - [9.1.11.1.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i0_glob) - [9.1.11.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1`](#hosting_anyOf_i0_rewrites_items_anyOf_i1) - - [9.1.11.1.2.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i1_function) - - [9.1.11.1.2.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i1_glob) - - [9.1.11.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region](#hosting_anyOf_i0_rewrites_items_anyOf_i1_region) + - [9.1.11.1.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i1_function) + - [9.1.11.1.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i1_glob) + - [9.1.11.1.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i1_region) - [9.1.11.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2`](#hosting_anyOf_i0_rewrites_items_anyOf_i2) - - [9.1.11.1.3.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function) - - [9.1.11.1.3.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_functionId) - - [9.1.11.1.3.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_pinTag) - - [9.1.11.1.3.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_region) - - [9.1.11.1.3.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i2_glob) + - [9.1.11.1.3.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function) + - [9.1.11.1.3.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_functionId) + - [9.1.11.1.3.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_pinTag) + - [9.1.11.1.3.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_region) + - [9.1.11.1.3.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_glob) - [9.1.11.1.4. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3`](#hosting_anyOf_i0_rewrites_items_anyOf_i3) - - [9.1.11.1.4.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i3_glob) - - [9.1.11.1.4.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run) - - [9.1.11.1.4.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_pinTag) - - [9.1.11.1.4.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_region) - - [9.1.11.1.4.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_serviceId) + - [9.1.11.1.4.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_glob) + - [9.1.11.1.4.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run) + - [9.1.11.1.4.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_pinTag) + - [9.1.11.1.4.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_region) + - [9.1.11.1.4.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_serviceId) - [9.1.11.1.5. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4`](#hosting_anyOf_i0_rewrites_items_anyOf_i4) - - [9.1.11.1.5.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i4_dynamicLinks) - - [9.1.11.1.5.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob](#hosting_anyOf_i0_rewrites_items_anyOf_i4_glob) + - [9.1.11.1.5.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks`](#hosting_anyOf_i0_rewrites_items_anyOf_i4_dynamicLinks) + - [9.1.11.1.5.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i4_glob) - [9.1.11.1.6. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5`](#hosting_anyOf_i0_rewrites_items_anyOf_i5) - - [9.1.11.1.6.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination](#hosting_anyOf_i0_rewrites_items_anyOf_i5_destination) - - [9.1.11.1.6.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i5_source) + - [9.1.11.1.6.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination`](#hosting_anyOf_i0_rewrites_items_anyOf_i5_destination) + - [9.1.11.1.6.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i5_source) - [9.1.11.1.7. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6`](#hosting_anyOf_i0_rewrites_items_anyOf_i6) - - [9.1.11.1.7.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i6_function) - - [9.1.11.1.7.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region](#hosting_anyOf_i0_rewrites_items_anyOf_i6_region) - - [9.1.11.1.7.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i6_source) + - [9.1.11.1.7.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i6_function) + - [9.1.11.1.7.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i6_region) + - [9.1.11.1.7.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i6_source) - [9.1.11.1.8. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7`](#hosting_anyOf_i0_rewrites_items_anyOf_i7) - - [9.1.11.1.8.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function) - - [9.1.11.1.8.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_functionId) - - [9.1.11.1.8.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_pinTag) - - [9.1.11.1.8.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_region) - - [9.1.11.1.8.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i7_source) + - [9.1.11.1.8.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function) + - [9.1.11.1.8.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_functionId) + - [9.1.11.1.8.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_pinTag) + - [9.1.11.1.8.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_region) + - [9.1.11.1.8.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_source) - [9.1.11.1.9. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8`](#hosting_anyOf_i0_rewrites_items_anyOf_i8) - - [9.1.11.1.9.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run) - - [9.1.11.1.9.1.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_pinTag) - - [9.1.11.1.9.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_region) - - [9.1.11.1.9.1.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_serviceId) - - [9.1.11.1.9.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i8_source) + - [9.1.11.1.9.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run) + - [9.1.11.1.9.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_pinTag) + - [9.1.11.1.9.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_region) + - [9.1.11.1.9.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_serviceId) + - [9.1.11.1.9.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_source) - [9.1.11.1.10. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9`](#hosting_anyOf_i0_rewrites_items_anyOf_i9) - - [9.1.11.1.10.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i9_dynamicLinks) - - [9.1.11.1.10.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source](#hosting_anyOf_i0_rewrites_items_anyOf_i9_source) + - [9.1.11.1.10.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks`](#hosting_anyOf_i0_rewrites_items_anyOf_i9_dynamicLinks) + - [9.1.11.1.10.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i9_source) - [9.1.11.1.11. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10`](#hosting_anyOf_i0_rewrites_items_anyOf_i10) - - [9.1.11.1.11.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination](#hosting_anyOf_i0_rewrites_items_anyOf_i10_destination) - - [9.1.11.1.11.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i10_regex) + - [9.1.11.1.11.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination`](#hosting_anyOf_i0_rewrites_items_anyOf_i10_destination) + - [9.1.11.1.11.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i10_regex) - [9.1.11.1.12. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11`](#hosting_anyOf_i0_rewrites_items_anyOf_i11) - - [9.1.11.1.12.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i11_function) - - [9.1.11.1.12.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i11_regex) - - [9.1.11.1.12.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region](#hosting_anyOf_i0_rewrites_items_anyOf_i11_region) + - [9.1.11.1.12.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i11_function) + - [9.1.11.1.12.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i11_regex) + - [9.1.11.1.12.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i11_region) - [9.1.11.1.13. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12`](#hosting_anyOf_i0_rewrites_items_anyOf_i12) - - [9.1.11.1.13.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function) - - [9.1.11.1.13.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_functionId) - - [9.1.11.1.13.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_pinTag) - - [9.1.11.1.13.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_region) - - [9.1.11.1.13.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i12_regex) + - [9.1.11.1.13.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function) + - [9.1.11.1.13.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_functionId) + - [9.1.11.1.13.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_pinTag) + - [9.1.11.1.13.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_region) + - [9.1.11.1.13.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_regex) - [9.1.11.1.14. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13`](#hosting_anyOf_i0_rewrites_items_anyOf_i13) - - [9.1.11.1.14.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i13_regex) - - [9.1.11.1.14.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run) - - [9.1.11.1.14.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_pinTag) - - [9.1.11.1.14.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_region) - - [9.1.11.1.14.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_serviceId) + - [9.1.11.1.14.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_regex) + - [9.1.11.1.14.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run) + - [9.1.11.1.14.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_pinTag) + - [9.1.11.1.14.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_region) + - [9.1.11.1.14.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_serviceId) - [9.1.11.1.15. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14`](#hosting_anyOf_i0_rewrites_items_anyOf_i14) - - [9.1.11.1.15.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i14_dynamicLinks) - - [9.1.11.1.15.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex](#hosting_anyOf_i0_rewrites_items_anyOf_i14_regex) - - [9.1.12. [Optional] Property root > hosting > anyOf > item 0 > site](#hosting_anyOf_i0_site) - - [9.1.13. [Optional] Property root > hosting > anyOf > item 0 > source](#hosting_anyOf_i0_source) - - [9.1.14. [Optional] Property root > hosting > anyOf > item 0 > target](#hosting_anyOf_i0_target) - - [9.1.15. [Optional] Property root > hosting > anyOf > item 0 > trailingSlash](#hosting_anyOf_i0_trailingSlash) + - [9.1.11.1.15.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks`](#hosting_anyOf_i0_rewrites_items_anyOf_i14_dynamicLinks) + - [9.1.11.1.15.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i14_regex) + - [9.1.12. Property `root > hosting > anyOf > item 0 > site`](#hosting_anyOf_i0_site) + - [9.1.13. Property `root > hosting > anyOf > item 0 > source`](#hosting_anyOf_i0_source) + - [9.1.14. Property `root > hosting > anyOf > item 0 > target`](#hosting_anyOf_i0_target) + - [9.1.15. Property `root > hosting > anyOf > item 0 > trailingSlash`](#hosting_anyOf_i0_trailingSlash) - [9.2. Property `root > hosting > anyOf > item 1`](#hosting_anyOf_i1) - - [9.2.1. root > hosting > anyOf > item 1 > item 1 items](#autogenerated_heading_36) + - [9.2.1. root > hosting > anyOf > item 1 > item 1 items](#hosting_anyOf_i1_items) - [9.2.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0) - - [9.2.1.1.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation](#hosting_anyOf_i1_items_anyOf_i0_appAssociation) - - [9.2.1.1.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls](#hosting_anyOf_i1_items_anyOf_i0_cleanUrls) - - [9.2.1.1.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend](#hosting_anyOf_i1_items_anyOf_i0_frameworksBackend) - - [9.2.1.1.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers](#hosting_anyOf_i1_items_anyOf_i0_headers) - - [9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders](#autogenerated_heading_37) - - [9.2.1.1.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n](#hosting_anyOf_i1_items_anyOf_i0_i18n) - - [9.2.1.1.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root](#hosting_anyOf_i1_items_anyOf_i0_i18n_root) - - [9.2.1.1.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore](#hosting_anyOf_i1_items_anyOf_i0_ignore) - - [9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items](#autogenerated_heading_38) - - [9.2.1.1.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy](#hosting_anyOf_i1_items_anyOf_i0_postdeploy) + - [9.2.1.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation`](#hosting_anyOf_i1_items_anyOf_i0_appAssociation) + - [9.2.1.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls`](#hosting_anyOf_i1_items_anyOf_i0_cleanUrls) + - [9.2.1.1.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend`](#hosting_anyOf_i1_items_anyOf_i0_frameworksBackend) + - [9.2.1.1.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers`](#hosting_anyOf_i1_items_anyOf_i0_headers) + - [9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders](#hosting_anyOf_i1_items_anyOf_i0_headers_items) + - [9.2.1.1.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n`](#hosting_anyOf_i1_items_anyOf_i0_i18n) + - [9.2.1.1.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root`](#hosting_anyOf_i1_items_anyOf_i0_i18n_root) + - [9.2.1.1.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore`](#hosting_anyOf_i1_items_anyOf_i0_ignore) + - [9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items](#hosting_anyOf_i1_items_anyOf_i0_ignore_items) + - [9.2.1.1.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy) - [9.2.1.1.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) - - [9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_39) + - [9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) - [9.2.1.1.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) - - [9.2.1.1.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy](#hosting_anyOf_i1_items_anyOf_i0_predeploy) + - [9.2.1.1.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy`](#hosting_anyOf_i1_items_anyOf_i0_predeploy) - [9.2.1.1.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) - - [9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_40) + - [9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) - [9.2.1.1.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) - - [9.2.1.1.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public](#hosting_anyOf_i1_items_anyOf_i0_public) - - [9.2.1.1.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects](#hosting_anyOf_i1_items_anyOf_i0_redirects) - - [9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects](#autogenerated_heading_41) - - [9.2.1.1.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites) - - [9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites](#autogenerated_heading_42) - - [9.2.1.1.12. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site](#hosting_anyOf_i1_items_anyOf_i0_site) - - [9.2.1.1.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source](#hosting_anyOf_i1_items_anyOf_i0_source) - - [9.2.1.1.14. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target](#hosting_anyOf_i1_items_anyOf_i0_target) - - [9.2.1.1.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash](#hosting_anyOf_i1_items_anyOf_i0_trailingSlash) + - [9.2.1.1.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public`](#hosting_anyOf_i1_items_anyOf_i0_public) + - [9.2.1.1.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects`](#hosting_anyOf_i1_items_anyOf_i0_redirects) + - [9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects](#hosting_anyOf_i1_items_anyOf_i0_redirects_items) + - [9.2.1.1.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites`](#hosting_anyOf_i1_items_anyOf_i0_rewrites) + - [9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites_items) + - [9.2.1.1.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site`](#hosting_anyOf_i1_items_anyOf_i0_site) + - [9.2.1.1.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source`](#hosting_anyOf_i1_items_anyOf_i0_source) + - [9.2.1.1.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target`](#hosting_anyOf_i1_items_anyOf_i0_target) + - [9.2.1.1.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash`](#hosting_anyOf_i1_items_anyOf_i0_trailingSlash) - [9.2.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1) - - [9.2.1.2.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation](#hosting_anyOf_i1_items_anyOf_i1_appAssociation) - - [9.2.1.2.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls](#hosting_anyOf_i1_items_anyOf_i1_cleanUrls) - - [9.2.1.2.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend](#hosting_anyOf_i1_items_anyOf_i1_frameworksBackend) - - [9.2.1.2.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers](#hosting_anyOf_i1_items_anyOf_i1_headers) - - [9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders](#autogenerated_heading_43) - - [9.2.1.2.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n](#hosting_anyOf_i1_items_anyOf_i1_i18n) - - [9.2.1.2.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root](#hosting_anyOf_i1_items_anyOf_i1_i18n_root) - - [9.2.1.2.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore](#hosting_anyOf_i1_items_anyOf_i1_ignore) - - [9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items](#autogenerated_heading_44) - - [9.2.1.2.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy](#hosting_anyOf_i1_items_anyOf_i1_postdeploy) + - [9.2.1.2.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation`](#hosting_anyOf_i1_items_anyOf_i1_appAssociation) + - [9.2.1.2.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls`](#hosting_anyOf_i1_items_anyOf_i1_cleanUrls) + - [9.2.1.2.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend`](#hosting_anyOf_i1_items_anyOf_i1_frameworksBackend) + - [9.2.1.2.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers`](#hosting_anyOf_i1_items_anyOf_i1_headers) + - [9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders](#hosting_anyOf_i1_items_anyOf_i1_headers_items) + - [9.2.1.2.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n`](#hosting_anyOf_i1_items_anyOf_i1_i18n) + - [9.2.1.2.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root`](#hosting_anyOf_i1_items_anyOf_i1_i18n_root) + - [9.2.1.2.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore`](#hosting_anyOf_i1_items_anyOf_i1_ignore) + - [9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items](#hosting_anyOf_i1_items_anyOf_i1_ignore_items) + - [9.2.1.2.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy) - [9.2.1.2.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) - - [9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_45) + - [9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) - [9.2.1.2.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) - - [9.2.1.2.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy](#hosting_anyOf_i1_items_anyOf_i1_predeploy) + - [9.2.1.2.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy`](#hosting_anyOf_i1_items_anyOf_i1_predeploy) - [9.2.1.2.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) - - [9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_46) + - [9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) - [9.2.1.2.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) - - [9.2.1.2.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public](#hosting_anyOf_i1_items_anyOf_i1_public) - - [9.2.1.2.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects](#hosting_anyOf_i1_items_anyOf_i1_redirects) - - [9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects](#autogenerated_heading_47) - - [9.2.1.2.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites) - - [9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites](#autogenerated_heading_48) - - [9.2.1.2.12. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site](#hosting_anyOf_i1_items_anyOf_i1_site) - - [9.2.1.2.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source](#hosting_anyOf_i1_items_anyOf_i1_source) - - [9.2.1.2.14. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target](#hosting_anyOf_i1_items_anyOf_i1_target) - - [9.2.1.2.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash](#hosting_anyOf_i1_items_anyOf_i1_trailingSlash) -- [10. [Optional] Property root > remoteconfig](#remoteconfig) - - [10.1. [Optional] Property root > remoteconfig > postdeploy](#remoteconfig_postdeploy) + - [9.2.1.2.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public`](#hosting_anyOf_i1_items_anyOf_i1_public) + - [9.2.1.2.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects`](#hosting_anyOf_i1_items_anyOf_i1_redirects) + - [9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects](#hosting_anyOf_i1_items_anyOf_i1_redirects_items) + - [9.2.1.2.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites`](#hosting_anyOf_i1_items_anyOf_i1_rewrites) + - [9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites_items) + - [9.2.1.2.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site`](#hosting_anyOf_i1_items_anyOf_i1_site) + - [9.2.1.2.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source`](#hosting_anyOf_i1_items_anyOf_i1_source) + - [9.2.1.2.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target`](#hosting_anyOf_i1_items_anyOf_i1_target) + - [9.2.1.2.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash`](#hosting_anyOf_i1_items_anyOf_i1_trailingSlash) +- [10. Property `root > remoteconfig`](#remoteconfig) + - [10.1. Property `root > remoteconfig > postdeploy`](#remoteconfig_postdeploy) - [10.1.1. Property `root > remoteconfig > postdeploy > anyOf > item 0`](#remoteconfig_postdeploy_anyOf_i0) - - [10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_49) + - [10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items](#remoteconfig_postdeploy_anyOf_i0_items) - [10.1.2. Property `root > remoteconfig > postdeploy > anyOf > item 1`](#remoteconfig_postdeploy_anyOf_i1) - - [10.2. [Optional] Property root > remoteconfig > predeploy](#remoteconfig_predeploy) + - [10.2. Property `root > remoteconfig > predeploy`](#remoteconfig_predeploy) - [10.2.1. Property `root > remoteconfig > predeploy > anyOf > item 0`](#remoteconfig_predeploy_anyOf_i0) - - [10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_50) + - [10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items](#remoteconfig_predeploy_anyOf_i0_items) - [10.2.2. Property `root > remoteconfig > predeploy > anyOf > item 1`](#remoteconfig_predeploy_anyOf_i1) - - [10.3. [Required] Property root > remoteconfig > template](#remoteconfig_template) -- [11. [Optional] Property root > storage](#storage) + - [10.3. Property `root > remoteconfig > template`](#remoteconfig_template) +- [11. Property `root > storage`](#storage) - [11.1. Property `root > storage > anyOf > StorageSingle`](#storage_anyOf_i0) - - [11.1.1. [Optional] Property root > storage > anyOf > item 0 > postdeploy](#storage_anyOf_i0_postdeploy) + - [11.1.1. Property `root > storage > anyOf > item 0 > postdeploy`](#storage_anyOf_i0_postdeploy) - [11.1.1.1. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 0`](#storage_anyOf_i0_postdeploy_anyOf_i0) - - [11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_51) + - [11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i0_postdeploy_anyOf_i0_items) - [11.1.1.2. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 1`](#storage_anyOf_i0_postdeploy_anyOf_i1) - - [11.1.2. [Optional] Property root > storage > anyOf > item 0 > predeploy](#storage_anyOf_i0_predeploy) + - [11.1.2. Property `root > storage > anyOf > item 0 > predeploy`](#storage_anyOf_i0_predeploy) - [11.1.2.1. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 0`](#storage_anyOf_i0_predeploy_anyOf_i0) - - [11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_52) + - [11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i0_predeploy_anyOf_i0_items) - [11.1.2.2. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 1`](#storage_anyOf_i0_predeploy_anyOf_i1) - - [11.1.3. [Required] Property root > storage > anyOf > item 0 > rules](#storage_anyOf_i0_rules) - - [11.1.4. [Optional] Property root > storage > anyOf > item 0 > target](#storage_anyOf_i0_target) + - [11.1.3. Property `root > storage > anyOf > item 0 > rules`](#storage_anyOf_i0_rules) + - [11.1.4. Property `root > storage > anyOf > item 0 > target`](#storage_anyOf_i0_target) - [11.2. Property `root > storage > anyOf > item 1`](#storage_anyOf_i1) - - [11.2.1. root > storage > anyOf > item 1 > item 1 items](#autogenerated_heading_53) - - [11.2.1.1. [Required] Property root > storage > anyOf > item 1 > item 1 items > bucket](#storage_anyOf_i1_items_bucket) - - [11.2.1.2. [Optional] Property root > storage > anyOf > item 1 > item 1 items > postdeploy](#storage_anyOf_i1_items_postdeploy) + - [11.2.1. root > storage > anyOf > item 1 > item 1 items](#storage_anyOf_i1_items) + - [11.2.1.1. Property `root > storage > anyOf > item 1 > item 1 items > bucket`](#storage_anyOf_i1_items_bucket) + - [11.2.1.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy`](#storage_anyOf_i1_items_postdeploy) - [11.2.1.2.1. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0`](#storage_anyOf_i1_items_postdeploy_anyOf_i0) - - [11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_54) + - [11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i1_items_postdeploy_anyOf_i0_items) - [11.2.1.2.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 1`](#storage_anyOf_i1_items_postdeploy_anyOf_i1) - - [11.2.1.3. [Optional] Property root > storage > anyOf > item 1 > item 1 items > predeploy](#storage_anyOf_i1_items_predeploy) + - [11.2.1.3. Property `root > storage > anyOf > item 1 > item 1 items > predeploy`](#storage_anyOf_i1_items_predeploy) - [11.2.1.3.1. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0`](#storage_anyOf_i1_items_predeploy_anyOf_i0) - - [11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items](#autogenerated_heading_55) + - [11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i1_items_predeploy_anyOf_i0_items) - [11.2.1.3.2. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 1`](#storage_anyOf_i1_items_predeploy_anyOf_i1) - - [11.2.1.4. [Required] Property root > storage > anyOf > item 1 > item 1 items > rules](#storage_anyOf_i1_items_rules) - - [11.2.1.5. [Optional] Property root > storage > anyOf > item 1 > item 1 items > target](#storage_anyOf_i1_items_target) + - [11.2.1.4. Property `root > storage > anyOf > item 1 > item 1 items > rules`](#storage_anyOf_i1_items_rules) + - [11.2.1.5. Property `root > storage > anyOf > item 1 > item 1 items > target`](#storage_anyOf_i1_items_target) | | | | ------------------------- | ----------- | @@ -421,12 +421,21 @@ **Description:** Information about the resources in your Firebase project. This used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start` -
- - 1. [Optional] Property root > $schema +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------- | ------- | ----------- | ---------- | ----------------------------------- | ----------------------------------------------------------------------------- | +| - [$schema](#schema ) | No | string | No | - | Unused. Included in schema so that the schema can be applied to single files. | +| - [apphosting](#apphosting ) | No | Combination | No | - | The App Hosting backend(s) that should be deployed or emulated. | +| - [database](#database ) | No | Combination | No | - | The Realtime Database rules that should be deployed or emulated. | +| - [dataconnect](#dataconnect ) | No | Combination | No | - | The Data Connect service(s) that should be deployed or emulated. | +| - [emulators](#emulators ) | No | object | No | - | Hosts, ports, and configuration options for the Firebase Emulator suite. | +| - [extensions](#extensions ) | No | object | No | In #/definitions/ExtensionsConfig | The Firebase Extension(s) that should be deployed or emulated. | +| - [firestore](#firestore ) | No | Combination | No | - | The Firestore rules and indexes that should be deployed or emulated. | +| - [functions](#functions ) | No | Combination | No | - | The Cloud Functions for Firebase that should be deployed or emulated. | +| - [hosting](#hosting ) | No | Combination | No | - | The Firebase Hosting site(s) that should be deployed or emulated. | +| - [remoteconfig](#remoteconfig ) | No | object | No | In #/definitions/RemoteConfigConfig | The Remote Config template(s) used by this project. | +| - [storage](#storage ) | No | Combination | No | - | The Firebase Storage rules that should be deployed or emulated. | - -
+## 1. Property `root > $schema` | | | | ------------ | -------- | @@ -436,15 +445,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Unused. Included in schema so that the schema can be applied to single files. -
-
- -
- - 2. [Optional] Property root > apphosting - - -
+## 2. Property `root > apphosting` | | | | ------------------------- | ---------------- | @@ -454,15 +455,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The App Hosting backend(s) that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------ | | [item 0](#apphosting_anyOf_i0) | | [item 1](#apphosting_anyOf_i1) | -
- ### 2.1. Property `root > apphosting > anyOf > item 0` | | | @@ -473,12 +470,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single App Hosting deployment configs -
- - 2.1.1. [Optional] Property root > apphosting > anyOf > item 0 > alwaysDeployFromSource +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------------------- | +| - [alwaysDeployFromSource](#apphosting_anyOf_i0_alwaysDeployFromSource ) | No | boolean | No | - | If true, this backend will only be deployed from local source, not from source control. | +| + [backendId](#apphosting_anyOf_i0_backendId ) | No | string | No | - | - | +| + [ignore](#apphosting_anyOf_i0_ignore ) | No | array of string | No | - | A list of file paths to exclude from the archive that is uploaded for this backend. | +| + [rootDir](#apphosting_anyOf_i0_rootDir ) | No | string | No | - | - | - -
+#### 2.1.1. Property `root > apphosting > anyOf > item 0 > alwaysDeployFromSource` | | | | ------------ | --------- | @@ -487,30 +486,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** If true, this backend will only be deployed from local source, not from source control. -
-
- -
- - 2.1.2. [Required] Property root > apphosting > anyOf > item 0 > backendId - - -
+#### 2.1.2. Property `root > apphosting > anyOf > item 0 > backendId` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 2.1.3. [Required] Property root > apphosting > anyOf > item 0 > ignore - - -
+#### 2.1.3. Property `root > apphosting > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -531,34 +514,20 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------- | ----------- | | [ignore items](#apphosting_anyOf_i0_ignore_items) | - | -##### 2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items +##### 2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 2.1.4. [Required] Property root > apphosting > anyOf > item 0 > rootDir - - -
+#### 2.1.4. Property `root > apphosting > anyOf > item 0 > rootDir` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
-
- ### 2.2. Property `root > apphosting > anyOf > item 1` | | | @@ -580,7 +549,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------ | --------------------------------------- | | [item 1 items](#apphosting_anyOf_i1_items) | A single App Hosting deployment configs | -#### 2.2.1. root > apphosting > anyOf > item 1 > item 1 items +#### 2.2.1. root > apphosting > anyOf > item 1 > item 1 items | | | | ------------------------- | ----------- | @@ -590,12 +559,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single App Hosting deployment configs -
- - 2.2.1.1. [Optional] Property root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------------------- | +| - [alwaysDeployFromSource](#apphosting_anyOf_i1_items_alwaysDeployFromSource ) | No | boolean | No | - | If true, this backend will only be deployed from local source, not from source control. | +| + [backendId](#apphosting_anyOf_i1_items_backendId ) | No | string | No | - | - | +| + [ignore](#apphosting_anyOf_i1_items_ignore ) | No | array of string | No | - | A list of file paths to exclude from the archive that is uploaded for this backend. | +| + [rootDir](#apphosting_anyOf_i1_items_rootDir ) | No | string | No | - | - | - -
+##### 2.2.1.1. Property `root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource` | | | | ------------ | --------- | @@ -604,30 +575,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** If true, this backend will only be deployed from local source, not from source control. -
-
- -
- - 2.2.1.2. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > backendId - - -
+##### 2.2.1.2. Property `root > apphosting > anyOf > item 1 > item 1 items > backendId` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 2.2.1.3. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > ignore - - -
+##### 2.2.1.3. Property `root > apphosting > anyOf > item 1 > item 1 items > ignore` | | | | ------------ | ----------------- | @@ -648,44 +603,21 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------------- | ----------- | | [ignore items](#apphosting_anyOf_i1_items_ignore_items) | - | -###### 2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items +###### 2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 2.2.1.4. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > rootDir - - -
+##### 2.2.1.4. Property `root > apphosting > anyOf > item 1 > item 1 items > rootDir` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- -
- -
-
- -
- - 3. [Optional] Property root > database - - -
+## 3. Property `root > database` | | | | ------------------------- | ---------------- | @@ -695,15 +627,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The Realtime Database rules that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------------ | | [DatabaseSingle](#database_anyOf_i0) | | [item 1](#database_anyOf_i1) | -
- ### 3.1. Property `root > database > anyOf > DatabaseSingle` | | | @@ -715,12 +643,13 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Deployment options for a single Realtime Database instance. -
- - 3.1.1. [Optional] Property root > database > anyOf > item 0 > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [postdeploy](#database_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#database_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#database_anyOf_i0_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | - -
+#### 3.1.1. Property `root > database > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -730,15 +659,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------------ | | [item 0](#database_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 3.1.1.1. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -758,16 +683,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------------------ | ----------- | | [item 0 items](#database_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 3.1.1.2. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -775,19 +697,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.1.2. [Optional] Property root > database > anyOf > item 0 > predeploy - - -
+#### 3.1.2. Property `root > database > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -797,15 +707,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ----------------------------------------------- | | [item 0](#database_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 3.1.2.1. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -825,16 +731,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | ----------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 3.1.2.2. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -842,19 +745,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.1.3. [Required] Property root > database > anyOf > item 0 > rules - - -
+#### 3.1.3. Property `root > database > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -863,12 +754,6 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -
-
- -
-
- ### 3.2. Property `root > database > anyOf > item 1` | | | @@ -890,7 +775,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ---------------------------------------- | ----------- | | [item 1 items](#database_anyOf_i1_items) | - | -#### 3.2.1. root > database > anyOf > item 1 > item 1 items +#### 3.2.1. root > database > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -898,15 +783,11 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Any type allowed | -
- | Any of(Option) | | ------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1) | -
- ##### 3.2.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -915,12 +796,15 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -
- - 3.2.1.1.1. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| + [instance](#database_anyOf_i1_items_anyOf_i0_instance ) | No | string | No | - | The instance that this rules files is for. | +| - [postdeploy](#database_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#database_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#database_anyOf_i1_items_anyOf_i0_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | +| - [target](#database_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | - | - -
+###### 3.2.1.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance` | | | | ------------ | -------- | @@ -929,15 +813,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The instance that this rules files is for. -
-
- -
- - 3.2.1.1.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy - - -
+###### 3.2.1.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -947,15 +823,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | -
- ###### 3.2.1.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -975,16 +847,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -992,19 +861,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.1.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy - - -
+###### 3.2.1.1.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -1014,15 +871,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | -
- ###### 3.2.1.1.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -1042,16 +895,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.1.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -1059,19 +909,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.1.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules - - -
+###### 3.2.1.1.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -1080,27 +918,13 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -
-
- -
- - 3.2.1.1.5. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target - - -
+###### 3.2.1.1.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- ##### 3.2.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -1109,12 +933,15 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -
- - 3.2.1.2.1. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [instance](#database_anyOf_i1_items_anyOf_i1_instance ) | No | string | No | - | The instance that this rules files is for. | +| - [postdeploy](#database_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#database_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#database_anyOf_i1_items_anyOf_i1_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | +| + [target](#database_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | - | - -
+###### 3.2.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance` | | | | ------------ | -------- | @@ -1123,15 +950,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The instance that this rules files is for. -
-
- -
- - 3.2.1.2.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy - - -
+###### 3.2.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` | | | | ------------------------- | ---------------- | @@ -1141,15 +960,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | -
- ###### 3.2.1.2.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -1169,16 +984,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.2.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -1186,19 +998,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.2.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy - - -
+###### 3.2.1.2.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` | | | | ------------------------- | ---------------- | @@ -1208,15 +1008,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | -
- ###### 3.2.1.2.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -1236,16 +1032,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.2.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -1253,19 +1046,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.2.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules - - -
+###### 3.2.1.2.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules` | | | | ------------ | -------- | @@ -1274,41 +1055,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -
-
- -
- - 3.2.1.2.5. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target - - -
+###### 3.2.1.2.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- -
- -
- -
- -
-
- -
- - 4. [Optional] Property root > dataconnect - - -
+## 4. Property `root > dataconnect` | | | | ------------------------- | ---------------- | @@ -1318,15 +1072,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The Data Connect service(s) that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------------------ | | [DataConnectSingle](#dataconnect_anyOf_i0) | | [item 1](#dataconnect_anyOf_i1) | -
- ### 4.1. Property `root > dataconnect > anyOf > DataConnectSingle` | | | @@ -1338,12 +1088,13 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single Data Connect deployment configs -
- - 4.1.1. [Optional] Property root > dataconnect > anyOf > item 0 > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [postdeploy](#dataconnect_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#dataconnect_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [source](#dataconnect_anyOf_i0_source ) | No | string | No | - | - | - -
+#### 4.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -1353,15 +1104,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | --------------------------------------------------- | | [item 0](#dataconnect_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#dataconnect_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 4.1.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -1381,16 +1128,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------- | ----------- | | [item 0 items](#dataconnect_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 4.1.1.2. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -1398,19 +1142,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 4.1.2. [Optional] Property root > dataconnect > anyOf > item 0 > predeploy - - -
+#### 4.1.2. Property `root > dataconnect > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -1420,15 +1152,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | -------------------------------------------------- | | [item 0](#dataconnect_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#dataconnect_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 4.1.2.1. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -1448,16 +1176,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------- | ----------- | | [item 0 items](#dataconnect_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 4.1.2.2. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -1465,31 +1190,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 4.1.3. [Required] Property root > dataconnect > anyOf > item 0 > source - - -
+#### 4.1.3. Property `root > dataconnect > anyOf > item 0 > source` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
-
- ### 4.2. Property `root > dataconnect > anyOf > item 1` | | | @@ -1511,7 +1218,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------ | ---------------------------------------- | | [DataConnectSingle](#dataconnect_anyOf_i1_items) | A single Data Connect deployment configs | -#### 4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle +#### 4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle | | | | ------------------------- | --------------------------------------------- | @@ -1522,19 +1229,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single Data Connect deployment configs -
- -
- -
-
- -
- - 5. [Optional] Property root > emulators - - -
+## 5. Property `root > emulators` | | | | ------------------------- | ----------- | @@ -1544,12 +1239,25 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Hosts, ports, and configuration options for the Firebase Emulator suite. -
- - 5.1. [Optional] Property root > emulators > apphosting - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------------------- | +| - [apphosting](#emulators_apphosting ) | No | object | No | - | Config for the App Hosting emulator | +| - [auth](#emulators_auth ) | No | object | No | - | Config for the Auth emulator | +| - [database](#emulators_database ) | No | object | No | - | Config for the Realtime Database emulator | +| - [dataconnect](#emulators_dataconnect ) | No | object | No | - | Config for the Data Connect emulator. | +| - [eventarc](#emulators_eventarc ) | No | object | No | - | Config for the EventArc emulator. | +| - [extensions](#emulators_extensions ) | No | object | No | - | Placeholder - the Extensions emulator has no configuration options. | +| - [firestore](#emulators_firestore ) | No | object | No | - | Config for the Firestore emulator | +| - [hosting](#emulators_hosting ) | No | object | No | - | Config for the Firebase Hosting emulator | +| - [hub](#emulators_hub ) | No | object | No | - | Config for the emulator suite hub. | +| - [logging](#emulators_logging ) | No | object | No | - | Config for the logging emulator. | +| - [pubsub](#emulators_pubsub ) | No | object | No | - | Config for the Pub/Sub emulator | +| - [singleProjectMode](#emulators_singleProjectMode ) | No | boolean | No | - | If true, the Emulator Suite will only allow a single project to be used at a time. | +| - [storage](#emulators_storage ) | No | object | No | - | Config for the Firebase Storage emulator | +| - [tasks](#emulators_tasks ) | No | object | No | - | Config for the Cloud Tasks emulator. | +| - [ui](#emulators_ui ) | No | object | No | - | Config for the Emulator UI. | + +### 5.1. Property `root > emulators > apphosting` | | | | ------------------------- | ----------- | @@ -1559,12 +1267,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the App Hosting emulator -
- - 5.1.1. [Optional] Property root > emulators > apphosting > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------- | +| - [host](#emulators_apphosting_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_apphosting_port ) | No | number | No | - | The port that this emulator will serve on. | +| - [rootDirectory](#emulators_apphosting_rootDirectory ) | No | string | No | - | The root directory of your app. The start command will ran from this directory. | +| - [startCommand](#emulators_apphosting_startCommand ) | No | string | No | - | The command that will be run to start your app when emulating your App Hosting backend | +| - [startCommandOverride](#emulators_apphosting_startCommandOverride ) | No | string | No | - | - | - -
+#### 5.1.1. Property `root > emulators > apphosting > host` | | | | ------------ | -------- | @@ -1573,15 +1284,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -
-
- -
- - 5.1.2. [Optional] Property root > emulators > apphosting > port - - -
+#### 5.1.2. Property `root > emulators > apphosting > port` | | | | ------------ | -------- | @@ -1590,15 +1293,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -
-
- -
- - 5.1.3. [Optional] Property root > emulators > apphosting > rootDirectory - - -
+#### 5.1.3. Property `root > emulators > apphosting > rootDirectory` | | | | ------------ | -------- | @@ -1607,15 +1302,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The root directory of your app. The start command will ran from this directory. -
-
- -
- - 5.1.4. [Optional] Property root > emulators > apphosting > startCommand - - -
+#### 5.1.4. Property `root > emulators > apphosting > startCommand` | | | | ------------ | -------- | @@ -1624,33 +1311,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The command that will be run to start your app when emulating your App Hosting backend -
-
- -
- - 5.1.5. [Optional] Property root > emulators > apphosting > startCommandOverride - - -
+#### 5.1.5. Property `root > emulators > apphosting > startCommandOverride` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- -
- - 5.2. [Optional] Property root > emulators > auth - - -
+### 5.2. Property `root > emulators > auth` | | | | ------------------------- | ----------- | @@ -1660,12 +1328,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Auth emulator -
- - 5.2.1. [Optional] Property root > emulators > auth > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_auth_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_auth_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.2.1. Property `root > emulators > auth > host` | | | | ------------ | -------- | @@ -1674,15 +1342,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -
-
- -
- - 5.2.2. [Optional] Property root > emulators > auth > port - - -
+#### 5.2.2. Property `root > emulators > auth > port` | | | | ------------ | -------- | @@ -1691,18 +1351,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.3. [Optional] Property root > emulators > database - - -
+### 5.3. Property `root > emulators > database` | | | | ------------------------- | ----------- | @@ -1712,12 +1361,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Realtime Database emulator -
- - 5.3.1. [Optional] Property root > emulators > database > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_database_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_database_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.3.1. Property `root > emulators > database > host` | | | | ------------ | -------- | @@ -1726,15 +1375,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -
-
- -
- - 5.3.2. [Optional] Property root > emulators > database > port - - -
+#### 5.3.2. Property `root > emulators > database > port` | | | | ------------ | -------- | @@ -1743,18 +1384,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.4. [Optional] Property root > emulators > dataconnect - - -
+### 5.4. Property `root > emulators > dataconnect` | | | | ------------------------- | ----------- | @@ -1764,12 +1394,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Data Connect emulator. -
- - 5.4.1. [Optional] Property root > emulators > dataconnect > dataDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [dataDir](#emulators_dataconnect_dataDir ) | No | string | No | - | The directory to persist emulator data to. If set, data will be saved between runs automatically.
If the --import flag is used, the current data will be overwritten by the imported data. | +| - [host](#emulators_dataconnect_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_dataconnect_port ) | No | number | No | - | The port that this emulator will serve on. | +| - [postgresHost](#emulators_dataconnect_postgresHost ) | No | string | No | - | Host for the Postgres database that backs the Data Connect emulator. | +| - [postgresPort](#emulators_dataconnect_postgresPort ) | No | number | No | - | Port for the Postgres database that backs the Data Connect emulator. | - -
+#### 5.4.1. Property `root > emulators > dataconnect > dataDir` | | | | ------------ | -------- | @@ -1779,15 +1412,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The directory to persist emulator data to. If set, data will be saved between runs automatically. If the --import flag is used, the current data will be overwritten by the imported data. -
-
- -
- - 5.4.2. [Optional] Property root > emulators > dataconnect > host - - -
+#### 5.4.2. Property `root > emulators > dataconnect > host` | | | | ------------ | -------- | @@ -1796,15 +1421,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.4.3. [Optional] Property root > emulators > dataconnect > port - - -
+#### 5.4.3. Property `root > emulators > dataconnect > port` | | | | ------------ | -------- | @@ -1813,15 +1430,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
- - 5.4.4. [Optional] Property root > emulators > dataconnect > postgresHost - - -
+#### 5.4.4. Property `root > emulators > dataconnect > postgresHost` | | | | ------------ | -------- | @@ -1830,15 +1439,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Host for the Postgres database that backs the Data Connect emulator. -
-
- -
- - 5.4.5. [Optional] Property root > emulators > dataconnect > postgresPort - - -
+#### 5.4.5. Property `root > emulators > dataconnect > postgresPort` | | | | ------------ | -------- | @@ -1847,18 +1448,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Port for the Postgres database that backs the Data Connect emulator. -
-
- -
-
- -
- - 5.5. [Optional] Property root > emulators > eventarc - - -
+### 5.5. Property `root > emulators > eventarc` | | | | ------------------------- | ----------- | @@ -1868,12 +1458,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the EventArc emulator. -
- - 5.5.1. [Optional] Property root > emulators > eventarc > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_eventarc_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_eventarc_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.5.1. Property `root > emulators > eventarc > host` | | | | ------------ | -------- | @@ -1882,15 +1472,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.5.2. [Optional] Property root > emulators > eventarc > port - - -
+#### 5.5.2. Property `root > emulators > eventarc > port` | | | | ------------ | -------- | @@ -1899,18 +1481,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.6. [Optional] Property root > emulators > extensions - - -
+### 5.6. Property `root > emulators > extensions` | | | | ------------------------- | ---------------- | @@ -1920,15 +1491,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Placeholder - the Extensions emulator has no configuration options. -
-
- -
- - 5.7. [Optional] Property root > emulators > firestore - - -
+### 5.7. Property `root > emulators > firestore` | | | | ------------------------- | ----------- | @@ -1938,12 +1501,13 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firestore emulator -
- - 5.7.1. [Optional] Property root > emulators > firestore > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_firestore_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_firestore_port ) | No | number | No | - | The port that this emulator will serve on. | +| - [websocketPort](#emulators_firestore_websocketPort ) | No | number | No | - | - | - -
+#### 5.7.1. Property `root > emulators > firestore > host` | | | | ------------ | -------- | @@ -1952,15 +1516,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.7.2. [Optional] Property root > emulators > firestore > port - - -
+#### 5.7.2. Property `root > emulators > firestore > port` | | | | ------------ | -------- | @@ -1969,33 +1525,14 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
- - 5.7.3. [Optional] Property root > emulators > firestore > websocketPort - - -
+#### 5.7.3. Property `root > emulators > firestore > websocketPort` | | | | ------------ | -------- | | **Type** | `number` | | **Required** | No | -
-
- -
-
- -
- - 5.8. [Optional] Property root > emulators > hosting - - -
+### 5.8. Property `root > emulators > hosting` | | | | ------------------------- | ----------- | @@ -2005,12 +1542,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firebase Hosting emulator -
- - 5.8.1. [Optional] Property root > emulators > hosting > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_hosting_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_hosting_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.8.1. Property `root > emulators > hosting > host` | | | | ------------ | -------- | @@ -2019,15 +1556,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.8.2. [Optional] Property root > emulators > hosting > port - - -
+#### 5.8.2. Property `root > emulators > hosting > port` | | | | ------------ | -------- | @@ -2036,18 +1565,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.9. [Optional] Property root > emulators > hub - - -
+### 5.9. Property `root > emulators > hub` | | | | ------------------------- | ----------- | @@ -2057,12 +1575,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the emulator suite hub. -
- - 5.9.1. [Optional] Property root > emulators > hub > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_hub_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_hub_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.9.1. Property `root > emulators > hub > host` | | | | ------------ | -------- | @@ -2071,15 +1589,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.9.2. [Optional] Property root > emulators > hub > port - - -
+#### 5.9.2. Property `root > emulators > hub > port` | | | | ------------ | -------- | @@ -2088,18 +1598,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.10. [Optional] Property root > emulators > logging - - -
+### 5.10. Property `root > emulators > logging` | | | | ------------------------- | ----------- | @@ -2109,12 +1608,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the logging emulator. -
- - 5.10.1. [Optional] Property root > emulators > logging > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_logging_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_logging_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.10.1. Property `root > emulators > logging > host` | | | | ------------ | -------- | @@ -2123,15 +1622,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.10.2. [Optional] Property root > emulators > logging > port - - -
+#### 5.10.2. Property `root > emulators > logging > port` | | | | ------------ | -------- | @@ -2140,18 +1631,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.11. [Optional] Property root > emulators > pubsub - - -
+### 5.11. Property `root > emulators > pubsub` | | | | ------------------------- | ----------- | @@ -2161,12 +1641,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Pub/Sub emulator -
- - 5.11.1. [Optional] Property root > emulators > pubsub > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_pubsub_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_pubsub_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.11.1. Property `root > emulators > pubsub > host` | | | | ------------ | -------- | @@ -2175,15 +1655,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.11.2. [Optional] Property root > emulators > pubsub > port - - -
+#### 5.11.2. Property `root > emulators > pubsub > port` | | | | ------------ | -------- | @@ -2192,18 +1664,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.12. [Optional] Property root > emulators > singleProjectMode - - -
+### 5.12. Property `root > emulators > singleProjectMode` | | | | ------------ | --------- | @@ -2212,15 +1673,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** If true, the Emulator Suite will only allow a single project to be used at a time. -
-
- -
- - 5.13. [Optional] Property root > emulators > storage - - -
+### 5.13. Property `root > emulators > storage` | | | | ------------------------- | ----------- | @@ -2230,12 +1683,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firebase Storage emulator -
- - 5.13.1. [Optional] Property root > emulators > storage > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_storage_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_storage_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.13.1. Property `root > emulators > storage > host` | | | | ------------ | -------- | @@ -2244,15 +1697,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.13.2. [Optional] Property root > emulators > storage > port - - -
+#### 5.13.2. Property `root > emulators > storage > port` | | | | ------------ | -------- | @@ -2261,18 +1706,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.14. [Optional] Property root > emulators > tasks - - -
+### 5.14. Property `root > emulators > tasks` | | | | ------------------------- | ----------- | @@ -2282,12 +1716,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Cloud Tasks emulator. -
- - 5.14.1. [Optional] Property root > emulators > tasks > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_tasks_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_tasks_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.14.1. Property `root > emulators > tasks > host` | | | | ------------ | -------- | @@ -2296,15 +1730,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.14.2. [Optional] Property root > emulators > tasks > port - - -
+#### 5.14.2. Property `root > emulators > tasks > port` | | | | ------------ | -------- | @@ -2313,18 +1739,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.15. [Optional] Property root > emulators > ui - - -
+### 5.15. Property `root > emulators > ui` | | | | ------------------------- | ----------- | @@ -2334,12 +1749,13 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Emulator UI. -
- - 5.15.1. [Optional] Property root > emulators > ui > enabled +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------- | ---------- | ---------- | --------------------------------------------- | +| - [enabled](#emulators_ui_enabled ) | No | boolean | No | - | If false, the Emulator UI will not be served. | +| - [host](#emulators_ui_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_ui_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.15.1. Property `root > emulators > ui > enabled` | | | | ------------ | --------- | @@ -2348,15 +1764,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** If false, the Emulator UI will not be served. -
-
- -
- - 5.15.2. [Optional] Property root > emulators > ui > host - - -
+#### 5.15.2. Property `root > emulators > ui > host` | | | | ------------ | -------- | @@ -2365,15 +1773,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.15.3. [Optional] Property root > emulators > ui > port - - -
+#### 5.15.3. Property `root > emulators > ui > port` | | | | ------------ | -------- | @@ -2382,21 +1782,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
-
- -
- - 6. [Optional] Property root > extensions - - -
+## 6. Property `root > extensions` | | | | ------------------------- | ------------------------------ | @@ -2407,15 +1793,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The Firebase Extension(s) that should be deployed or emulated. -
-
- -
- - 7. [Optional] Property root > firestore - - -
+## 7. Property `root > firestore` | | | | ------------------------- | ---------------- | @@ -2425,15 +1803,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The Firestore rules and indexes that should be deployed or emulated. -
- | Any of(Option) | | -------------------------------------- | | [FirestoreSingle](#firestore_anyOf_i0) | | [item 1](#firestore_anyOf_i1) | -
- ### 7.1. Property `root > firestore > anyOf > FirestoreSingle` | | | @@ -2445,12 +1819,16 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Deployment options for a single Firestore database. -
- - 7.1.1. [Optional] Property root > firestore > anyOf > item 0 > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------- | +| - [database](#firestore_anyOf_i0_database ) | No | string | No | - | The id of the Firestore database to deploy. If omitted, defaults to '(default)' | +| - [indexes](#firestore_anyOf_i0_indexes ) | No | string | No | - | Path to the firestore indexes file | +| - [location](#firestore_anyOf_i0_location ) | No | string | No | - | The region of the Firestore database to deploy. Required when 'database' is set. | +| - [postdeploy](#firestore_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#firestore_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [rules](#firestore_anyOf_i0_rules ) | No | string | No | - | Path to the firestore rules file | - -
+#### 7.1.1. Property `root > firestore > anyOf > item 0 > database` | | | | ------------ | -------- | @@ -2459,15 +1837,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The id of the Firestore database to deploy. If omitted, defaults to '(default)' -
-
- -
- - 7.1.2. [Optional] Property root > firestore > anyOf > item 0 > indexes - - -
+#### 7.1.2. Property `root > firestore > anyOf > item 0 > indexes` | | | | ------------ | -------- | @@ -2476,15 +1846,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore indexes file -
-
- -
- - 7.1.3. [Optional] Property root > firestore > anyOf > item 0 > location - - -
+#### 7.1.3. Property `root > firestore > anyOf > item 0 > location` | | | | ------------ | -------- | @@ -2493,15 +1855,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The region of the Firestore database to deploy. Required when 'database' is set. -
-
- -
- - 7.1.4. [Optional] Property root > firestore > anyOf > item 0 > postdeploy - - -
+#### 7.1.4. Property `root > firestore > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -2511,15 +1865,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------------- | | [item 0](#firestore_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 7.1.4.1. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -2539,16 +1889,13 @@ If the --import flag is used, the current data will be overwritten by the import | ------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 7.1.4.2. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -2556,19 +1903,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.1.5. [Optional] Property root > firestore > anyOf > item 0 > predeploy - - -
+#### 7.1.5. Property `root > firestore > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -2578,15 +1913,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------ | | [item 0](#firestore_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 7.1.5.1. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -2606,16 +1937,13 @@ If the --import flag is used, the current data will be overwritten by the import | ------------------------------------------------------------ | ----------- | | [item 0 items](#firestore_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 7.1.5.2. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -2623,19 +1951,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.1.6. [Optional] Property root > firestore > anyOf > item 0 > rules - - -
+#### 7.1.6. Property `root > firestore > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -2644,12 +1960,6 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore rules file -
-
- -
-
- ### 7.2. Property `root > firestore > anyOf > item 1` | | | @@ -2671,7 +1981,7 @@ If the --import flag is used, the current data will be overwritten by the import | ----------------------------------------- | ----------- | | [item 1 items](#firestore_anyOf_i1_items) | - | -#### 7.2.1. root > firestore > anyOf > item 1 > item 1 items +#### 7.2.1. root > firestore > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -2679,15 +1989,11 @@ If the --import flag is used, the current data will be overwritten by the import | **Required** | No | | **Additional properties** | Any type allowed | -
- | Any of(Option) | | -------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1) | -
- ##### 7.2.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -2696,12 +2002,16 @@ If the --import flag is used, the current data will be overwritten by the import | **Required** | No | | **Additional properties** | Not allowed | -
- - 7.2.1.1.1. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [database](#firestore_anyOf_i1_items_anyOf_i0_database ) | No | string | No | - | The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. | +| - [indexes](#firestore_anyOf_i1_items_anyOf_i0_indexes ) | No | string | No | - | Path to the firestore indexes file for this database | +| - [postdeploy](#firestore_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#firestore_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [rules](#firestore_anyOf_i1_items_anyOf_i0_rules ) | No | string | No | - | Path to the firestore rules file for this database | +| + [target](#firestore_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | The deploy target these rules and indexes should be deployed to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+###### 7.2.1.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database` | | | | ------------ | -------- | @@ -2710,15 +2020,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. -
-
- -
- - 7.2.1.1.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes - - -
+###### 7.2.1.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes` | | | | ------------ | -------- | @@ -2727,15 +2029,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore indexes file for this database -
-
- -
- - 7.2.1.1.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy - - -
+###### 7.2.1.1.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -2745,15 +2039,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ---------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | -
- ###### 7.2.1.1.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -2773,16 +2063,13 @@ If the --import flag is used, the current data will be overwritten by the import | ---------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.1.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -2790,19 +2077,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.1.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy - - -
+###### 7.2.1.1.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -2812,15 +2087,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | -
- ###### 7.2.1.1.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -2840,16 +2111,13 @@ If the --import flag is used, the current data will be overwritten by the import | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.1.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -2857,19 +2125,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.1.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules - - -
+###### 7.2.1.1.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -2878,15 +2134,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore rules file for this database -
-
- -
- - 7.2.1.1.6. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target - - -
+###### 7.2.1.1.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -2896,12 +2144,6 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The deploy target these rules and indexes should be deployed to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
-
- ##### 7.2.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -2910,12 +2152,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 7.2.1.2.1. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [database](#firestore_anyOf_i1_items_anyOf_i1_database ) | No | string | No | - | The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. | +| - [indexes](#firestore_anyOf_i1_items_anyOf_i1_indexes ) | No | string | No | - | Path to the firestore indexes file for this database | +| - [postdeploy](#firestore_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#firestore_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [rules](#firestore_anyOf_i1_items_anyOf_i1_rules ) | No | string | No | - | Path to the firestore rules file for this database | +| - [target](#firestore_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | The deploy target these rules and indexes should be deployed to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+###### 7.2.1.2.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database` | | | | ------------ | -------- | @@ -2924,15 +2170,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. -
-
- -
- - 7.2.1.2.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes - - -
+###### 7.2.1.2.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes` | | | | ------------ | -------- | @@ -2941,15 +2179,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the firestore indexes file for this database -
-
- -
- - 7.2.1.2.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy - - -
+###### 7.2.1.2.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` | | | | ------------------------- | ---------------- | @@ -2959,15 +2189,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ---------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | -
- ###### 7.2.1.2.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -2987,16 +2213,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.2.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -3004,19 +2227,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.2.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy - - -
+###### 7.2.1.2.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` | | | | ------------------------- | ---------------- | @@ -3026,15 +2237,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | -
- ###### 7.2.1.2.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -3054,16 +2261,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.2.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -3071,19 +2275,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.2.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules - - -
+###### 7.2.1.2.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules` | | | | ------------ | -------- | @@ -3092,15 +2284,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the firestore rules file for this database -
-
- -
- - 7.2.1.2.6. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target - - -
+###### 7.2.1.2.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target` | | | | ------------ | -------- | @@ -3110,26 +2294,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target these rules and indexes should be deployed to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- -
- -
- -
- -
-
- -
- - 8. [Optional] Property root > functions - - -
+## 8. Property `root > functions` | | | | ------------------------- | ---------------- | @@ -3139,15 +2304,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Cloud Functions for Firebase that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------------- | | [FunctionConfig](#functions_anyOf_i0) | | [item 1](#functions_anyOf_i1) | -
- ### 8.1. Property `root > functions > anyOf > FunctionConfig` | | | @@ -3157,12 +2318,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/FunctionConfig | -
- - 8.1.1. [Optional] Property root > functions > anyOf > item 0 > codebase +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| - [codebase](#functions_anyOf_i0_codebase ) | No | string | No | - | The codebase that these functions are part of. You can use codebases to control which functions are deployed
ie: \`firebase deploy --only functions:my-codebase\` | +| - [ignore](#functions_anyOf_i0_ignore ) | No | array of string | No | - | Files in the source directory that should not be uploaed during dpeloyment. | +| - [postdeploy](#functions_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#functions_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [runtime](#functions_anyOf_i0_runtime ) | No | enum (of string) | No | - | The runtime these functions should use. | +| - [source](#functions_anyOf_i0_source ) | No | string | No | - | The directory containing your functions source code.
This directory will be archived and uploaded during deployment.
Files outside of this directory will not be included and should not be referenced from your functions code. | - -
+#### 8.1.1. Property `root > functions > anyOf > item 0 > codebase` | | | | ------------ | -------- | @@ -3172,15 +2337,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The codebase that these functions are part of. You can use codebases to control which functions are deployed ie: `firebase deploy --only functions:my-codebase` -
-
- -
- - 8.1.2. [Optional] Property root > functions > anyOf > item 0 > ignore - - -
+#### 8.1.2. Property `root > functions > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -3201,22 +2358,14 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------ | ----------- | | [ignore items](#functions_anyOf_i0_ignore_items) | - | -##### 8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items +##### 8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 8.1.3. [Optional] Property root > functions > anyOf > item 0 > postdeploy - - -
+#### 8.1.3. Property `root > functions > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -3226,15 +2375,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------------- | | [item 0](#functions_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#functions_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 8.1.3.1. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -3254,16 +2399,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------------- | ----------- | | [item 0 items](#functions_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 8.1.3.2. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -3271,19 +2413,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 8.1.4. [Optional] Property root > functions > anyOf > item 0 > predeploy - - -
+#### 8.1.4. Property `root > functions > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -3293,15 +2423,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------ | | [item 0](#functions_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#functions_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 8.1.4.1. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -3321,16 +2447,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------------ | ----------- | | [item 0 items](#functions_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 8.1.4.2. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -3338,19 +2461,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 8.1.5. [Optional] Property root > functions > anyOf > item 0 > runtime - - -
+#### 8.1.5. Property `root > functions > anyOf > item 0 > runtime` | | | | ------------ | ------------------ | @@ -3367,15 +2478,7 @@ Must be one of: * "python312" * "python313" -
-
- -
- - 8.1.6. [Optional] Property root > functions > anyOf > item 0 > source - - -
+#### 8.1.6. Property `root > functions > anyOf > item 0 > source` | | | | ------------ | -------- | @@ -3386,12 +2489,6 @@ Must be one of: This directory will be archived and uploaded during deployment. Files outside of this directory will not be included and should not be referenced from your functions code. -
-
- -
-
- ### 8.2. Property `root > functions > anyOf > item 1` | | | @@ -3411,7 +2508,7 @@ Files outside of this directory will not be included and should not be reference | ------------------------------------------- | ----------- | | [FunctionConfig](#functions_anyOf_i1_items) | - | -#### 8.2.1. root > functions > anyOf > item 1 > FunctionConfig +#### 8.2.1. root > functions > anyOf > item 1 > FunctionConfig | | | | ------------------------- | ----------------------------------------- | @@ -3420,19 +2517,7 @@ Files outside of this directory will not be included and should not be reference | **Additional properties** | Not allowed | | **Same definition as** | [functions_anyOf_i0](#functions_anyOf_i0) | -
- -
- -
-
- -
- - 9. [Optional] Property root > hosting - - -
+## 9. Property `root > hosting` | | | | ------------------------- | ---------------- | @@ -3442,15 +2527,11 @@ Files outside of this directory will not be included and should not be reference **Description:** The Firebase Hosting site(s) that should be deployed or emulated. -
- | Any of(Option) | | ---------------------------------- | | [HostingSingle](#hosting_anyOf_i0) | | [item 1](#hosting_anyOf_i1) | -
- ### 9.1. Property `root > hosting > anyOf > HostingSingle` | | | @@ -3462,12 +2543,25 @@ Files outside of this directory will not be included and should not be reference **Description:** Deployment options for a single Firebase Hosting site. -
- - 9.1.1. [Optional] Property root > hosting > anyOf > item 0 > appAssociation - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [appAssociation](#hosting_anyOf_i0_appAssociation ) | No | enum (of string) | No | - | - | +| - [cleanUrls](#hosting_anyOf_i0_cleanUrls ) | No | boolean | No | - | - | +| - [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | No | object | No | In #/definitions/FrameworksBackendOptions | Options for this sites web frameworks backend. | +| - [headers](#hosting_anyOf_i0_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | +| - [i18n](#hosting_anyOf_i0_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | +| - [ignore](#hosting_anyOf_i0_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | +| - [postdeploy](#hosting_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#hosting_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [public](#hosting_anyOf_i0_public ) | No | string | No | - | Whether this site should publically available. | +| - [redirects](#hosting_anyOf_i0_redirects ) | No | array | No | - | A list of redirects for this site. | +| - [rewrites](#hosting_anyOf_i0_rewrites ) | No | array | No | - | A list o rewrites for this site. | +| - [site](#hosting_anyOf_i0_site ) | No | string | No | - | The site to deploy. | +| - [source](#hosting_anyOf_i0_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | +| - [target](#hosting_anyOf_i0_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +| - [trailingSlash](#hosting_anyOf_i0_trailingSlash ) | No | boolean | No | - | - | + +#### 9.1.1. Property `root > hosting > anyOf > item 0 > appAssociation` | | | | ------------ | ------------------ | @@ -3478,30 +2572,14 @@ Must be one of: * "AUTO" * "NONE" -
-
- -
- - 9.1.2. [Optional] Property root > hosting > anyOf > item 0 > cleanUrls - - -
+#### 9.1.2. Property `root > hosting > anyOf > item 0 > cleanUrls` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- - 9.1.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend - - -
+#### 9.1.3. Property `root > hosting > anyOf > item 0 > frameworksBackend` | | | | ------------------------- | -------------------------------------- | @@ -3512,12 +2590,28 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -
- - 9.1.3.1. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > concurrency - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------------------------------- | ------- | ----------------- | ---------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [concurrency](#hosting_anyOf_i0_frameworksBackend_concurrency ) | No | number | No | - | Number of requests a function can serve at once. | +| - [cors](#hosting_anyOf_i0_frameworksBackend_cors ) | No | string or boolean | No | - | If true, allows CORS on requests to this function.
If this is a \`string\` or \`RegExp\`, allows requests from domains that match the provided value.
If this is an \`Array\`, allows requests from domains matching at least one entry of the array.
Defaults to true for {@link https.CallableFunction} and false otherwise. | +| - [cpu](#hosting_anyOf_i0_frameworksBackend_cpu ) | No | Combination | No | - | Fractional number of CPUs to allocate to a function. | +| - [enforceAppCheck](#hosting_anyOf_i0_frameworksBackend_enforceAppCheck ) | No | boolean | No | - | Determines whether Firebase AppCheck is enforced. Defaults to false. | +| - [ingressSettings](#hosting_anyOf_i0_frameworksBackend_ingressSettings ) | No | enum (of string) | No | - | Ingress settings which control where this function can be called from. | +| - [invoker](#hosting_anyOf_i0_frameworksBackend_invoker ) | No | const | No | - | Invoker to set access control on https functions. | +| - [labels](#hosting_anyOf_i0_frameworksBackend_labels ) | No | object | No | In #/definitions/Record | User labels to set on the function. | +| - [maxInstances](#hosting_anyOf_i0_frameworksBackend_maxInstances ) | No | number | No | - | Max number of instances to be running in parallel. | +| - [memory](#hosting_anyOf_i0_frameworksBackend_memory ) | No | enum (of string) | No | - | Amount of memory to allocate to a function. | +| - [minInstances](#hosting_anyOf_i0_frameworksBackend_minInstances ) | No | number | No | - | Min number of actual instances to be running at a given time. | +| - [omit](#hosting_anyOf_i0_frameworksBackend_omit ) | No | boolean | No | - | If true, do not deploy or emulate this function. | +| - [preserveExternalChanges](#hosting_anyOf_i0_frameworksBackend_preserveExternalChanges ) | No | boolean | No | - | Controls whether function configuration modified outside of function source is preserved. Defaults to false. | +| - [region](#hosting_anyOf_i0_frameworksBackend_region ) | No | string | No | - | HTTP functions can override global options and can specify multiple regions to deploy to. | +| - [secrets](#hosting_anyOf_i0_frameworksBackend_secrets ) | No | array of string | No | - | A list of secrets used in this app. | +| - [serviceAccount](#hosting_anyOf_i0_frameworksBackend_serviceAccount ) | No | string | No | - | Specific service account for the function to run as. | +| - [timeoutSeconds](#hosting_anyOf_i0_frameworksBackend_timeoutSeconds ) | No | number | No | - | Timeout for the function in seconds, possible values are 0 to 540.
HTTPS functions can specify a higher timeout. | +| - [vpcConnector](#hosting_anyOf_i0_frameworksBackend_vpcConnector ) | No | string | No | - | Connect cloud function to specified VPC connector. | +| - [vpcConnectorEgressSettings](#hosting_anyOf_i0_frameworksBackend_vpcConnectorEgressSettings ) | No | enum (of string) | No | - | Egress settings for VPC connector. | + +##### 9.1.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > concurrency` | | | | ------------ | -------- | @@ -3526,15 +2620,7 @@ Must be one of: **Description:** Number of requests a function can serve at once. -
-
- -
- - 9.1.3.2. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cors - - -
+##### 9.1.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cors` | | | | ------------ | ------------------- | @@ -3546,15 +2632,7 @@ If this is a `string` or `RegExp`, allows requests from domains that match the p If this is an `Array`, allows requests from domains matching at least one entry of the array. Defaults to true for {@link https.CallableFunction} and false otherwise. -
-
- -
- - 9.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cpu - - -
+##### 9.1.3.3. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu` | | | | ------------------------- | ---------------- | @@ -3564,15 +2642,11 @@ Defaults to true for {@link https.CallableFunction} and false otherwise. **Description:** Fractional number of CPUs to allocate to a function. -
- | Any of(Option) | | ---------------------------------------------------------- | | [item 0](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i0) | | [item 1](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i1) | -
- ###### 9.1.3.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 0` | | | @@ -3582,9 +2656,6 @@ Defaults to true for {@link https.CallableFunction} and false otherwise. Specific value: `"gcf_gen1"` -
-
- ###### 9.1.3.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 1` | | | @@ -3592,19 +2663,7 @@ Specific value: `"gcf_gen1"` | **Type** | `number` | | **Required** | No | -
- -
- -
-
- -
- - 9.1.3.4. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck - - -
+##### 9.1.3.4. Property `root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck` | | | | ------------ | --------- | @@ -3613,15 +2672,7 @@ Specific value: `"gcf_gen1"` **Description:** Determines whether Firebase AppCheck is enforced. Defaults to false. -
-
- -
- - 9.1.3.5. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings - - -
+##### 9.1.3.5. Property `root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings` | | | | ------------ | ------------------ | @@ -3635,15 +2686,7 @@ Must be one of: * "ALLOW_INTERNAL_AND_GCLB" * "ALLOW_INTERNAL_ONLY" -
-
- -
- - 9.1.3.6. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > invoker - - -
+##### 9.1.3.6. Property `root > hosting > anyOf > item 0 > frameworksBackend > invoker` | | | | ------------ | ------- | @@ -3654,15 +2697,7 @@ Must be one of: Specific value: `"public"` -
-
- -
- - 9.1.3.7. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > labels - - -
+##### 9.1.3.7. Property `root > hosting > anyOf > item 0 > frameworksBackend > labels` | | | | ------------------------- | ----------------------------------- | @@ -3673,15 +2708,7 @@ Specific value: `"public"` **Description:** User labels to set on the function. -
-
- -
- - 9.1.3.8. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > maxInstances - - -
+##### 9.1.3.8. Property `root > hosting > anyOf > item 0 > frameworksBackend > maxInstances` | | | | ------------ | -------- | @@ -3690,15 +2717,7 @@ Specific value: `"public"` **Description:** Max number of instances to be running in parallel. -
-
- -
- - 9.1.3.9. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > memory - - -
+##### 9.1.3.9. Property `root > hosting > anyOf > item 0 > frameworksBackend > memory` | | | | ------------ | ------------------ | @@ -3718,15 +2737,7 @@ Must be one of: * "512MiB" * "8GiB" -
-
- -
- - 9.1.3.10. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > minInstances - - -
+##### 9.1.3.10. Property `root > hosting > anyOf > item 0 > frameworksBackend > minInstances` | | | | ------------ | -------- | @@ -3735,15 +2746,7 @@ Must be one of: **Description:** Min number of actual instances to be running at a given time. -
-
- -
- - 9.1.3.11. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > omit - - -
+##### 9.1.3.11. Property `root > hosting > anyOf > item 0 > frameworksBackend > omit` | | | | ------------ | --------- | @@ -3752,15 +2755,7 @@ Must be one of: **Description:** If true, do not deploy or emulate this function. -
-
- -
- - 9.1.3.12. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges - - -
+##### 9.1.3.12. Property `root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges` | | | | ------------ | --------- | @@ -3769,15 +2764,7 @@ Must be one of: **Description:** Controls whether function configuration modified outside of function source is preserved. Defaults to false. -
-
- -
- - 9.1.3.13. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > region - - -
+##### 9.1.3.13. Property `root > hosting > anyOf > item 0 > frameworksBackend > region` | | | | ------------ | -------- | @@ -3786,15 +2773,7 @@ Must be one of: **Description:** HTTP functions can override global options and can specify multiple regions to deploy to. -
-
- -
- - 9.1.3.14. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > secrets - - -
+##### 9.1.3.14. Property `root > hosting > anyOf > item 0 > frameworksBackend > secrets` | | | | ------------ | ----------------- | @@ -3815,22 +2794,14 @@ Must be one of: | ------------------------------------------------------------------ | ----------- | | [secrets items](#hosting_anyOf_i0_frameworksBackend_secrets_items) | - | -###### 9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items +###### 9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.3.15. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount - - -
+##### 9.1.3.15. Property `root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount` | | | | ------------ | -------- | @@ -3839,15 +2810,7 @@ Must be one of: **Description:** Specific service account for the function to run as. -
-
- -
- - 9.1.3.16. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds - - -
+##### 9.1.3.16. Property `root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds` | | | | ------------ | -------- | @@ -3857,15 +2820,7 @@ Must be one of: **Description:** Timeout for the function in seconds, possible values are 0 to 540. HTTPS functions can specify a higher timeout. -
-
- -
- - 9.1.3.17. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector - - -
+##### 9.1.3.17. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector` | | | | ------------ | -------- | @@ -3874,15 +2829,7 @@ HTTPS functions can specify a higher timeout. **Description:** Connect cloud function to specified VPC connector. -
-
- -
- - 9.1.3.18. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings - - -
+##### 9.1.3.18. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings` | | | | ------------ | ------------------ | @@ -3895,18 +2842,7 @@ Must be one of: * "ALL_TRAFFIC" * "PRIVATE_RANGES_ONLY" -
-
- -
-
- -
- - 9.1.4. [Optional] Property root > hosting > anyOf > item 0 > headers - - -
+#### 9.1.4. Property `root > hosting > anyOf > item 0 > headers` | | | | ------------ | ------- | @@ -3927,7 +2863,7 @@ Must be one of: | ------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | -##### 9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders +##### 9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders | | | | ------------------------- | ---------------------------- | @@ -3938,16 +2874,12 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -
- | Any of(Option) | | -------------------------------------------------- | | [item 0](#hosting_anyOf_i0_headers_items_anyOf_i0) | | [item 1](#hosting_anyOf_i0_headers_items_anyOf_i1) | | [item 2](#hosting_anyOf_i0_headers_items_anyOf_i2) | -
- ###### 9.1.4.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0` | | | @@ -3956,12 +2888,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [glob](#hosting_anyOf_i0_headers_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i0_headers ) | No | array of object | No | - | - | - -
+###### 9.1.4.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob` | | | | ------------ | -------- | @@ -3970,15 +2902,7 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.4.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers - - -
+###### 9.1.4.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers` | | | | ------------ | ----------------- | @@ -3997,7 +2921,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items) | - | -###### 9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items +###### 9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items | | | | ------------------------- | ----------- | @@ -4005,12 +2929,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.1.2.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | +| + [key](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_key ) | No | string | No | - | The header to set. | +| + [value](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_value ) | No | string | No | - | The value to set this header to. | - -
+###### 9.1.4.1.1.2.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key` | | | | ------------ | -------- | @@ -4019,15 +2943,7 @@ Must be one of: **Description:** The header to set. -
-
- -
- - 9.1.4.1.1.2.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value - - -
+###### 9.1.4.1.1.2.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value` | | | | ------------ | -------- | @@ -4036,15 +2952,6 @@ Must be one of: **Description:** The value to set this header to. -
-
- -
-
- -
-
- ###### 9.1.4.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1` | | | @@ -4053,12 +2960,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.2.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ---------------------------------------------- | +| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i1_headers ) | No | array of object | No | - | - | +| + [source](#hosting_anyOf_i0_headers_items_anyOf_i1_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.4.1.2.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers` | | | | ------------ | ----------------- | @@ -4077,7 +2984,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items) | - | -###### 9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items +###### 9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items | | | | ------------------------- | ----------- | @@ -4085,12 +2992,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.2.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | +| + [key](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_key ) | No | string | No | - | The header to set. | +| + [value](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_value ) | No | string | No | - | The value to set this header to. | - -
+###### 9.1.4.1.2.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key` | | | | ------------ | -------- | @@ -4099,15 +3006,7 @@ Must be one of: **Description:** The header to set. -
-
- -
- - 9.1.4.1.2.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value - - -
+###### 9.1.4.1.2.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value` | | | | ------------ | -------- | @@ -4116,18 +3015,7 @@ Must be one of: **Description:** The value to set this header to. -
-
- -
-
- -
- - 9.1.4.1.2.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source - - -
+###### 9.1.4.1.2.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source` | | | | ------------ | -------- | @@ -4136,12 +3024,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.4.1.3. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2` | | | @@ -4150,12 +3032,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.3.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i2_headers ) | No | array of object | No | - | - | +| + [regex](#hosting_anyOf_i0_headers_items_anyOf_i2_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.4.1.3.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers` | | | | ------------ | ----------------- | @@ -4174,7 +3056,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items) | - | -###### 9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items +###### 9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items | | | | ------------------------- | ----------- | @@ -4182,12 +3064,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.3.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | +| + [key](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_key ) | No | string | No | - | The header to set. | +| + [value](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_value ) | No | string | No | - | The value to set this header to. | - -
+###### 9.1.4.1.3.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key` | | | | ------------ | -------- | @@ -4196,15 +3078,7 @@ Must be one of: **Description:** The header to set. -
-
- -
- - 9.1.4.1.3.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value - - -
+###### 9.1.4.1.3.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value` | | | | ------------ | -------- | @@ -4213,18 +3087,7 @@ Must be one of: **Description:** The value to set this header to. -
-
- -
-
- -
- - 9.1.4.1.3.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex - - -
+###### 9.1.4.1.3.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex` | | | | ------------ | -------- | @@ -4233,22 +3096,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- -
- -
-
- -
- - 9.1.5. [Optional] Property root > hosting > anyOf > item 0 > i18n - - -
+#### 9.1.5. Property `root > hosting > anyOf > item 0 > i18n` | | | | ------------------------- | ----------- | @@ -4260,12 +3108,11 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -
- - 9.1.5.1. [Required] Property root > hosting > anyOf > item 0 > i18n > root +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | +| + [root](#hosting_anyOf_i0_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | - -
+##### 9.1.5.1. Property `root > hosting > anyOf > item 0 > i18n > root` | | | | ------------ | -------- | @@ -4274,18 +3121,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -
-
- -
-
- -
- - 9.1.6. [Optional] Property root > hosting > anyOf > item 0 > ignore - - -
+#### 9.1.6. Property `root > hosting > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -4306,22 +3142,14 @@ for instructions on how to enable interntionalization for your site. | ---------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i0_ignore_items) | - | -##### 9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items +##### 9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.7. [Optional] Property root > hosting > anyOf > item 0 > postdeploy - - -
+#### 9.1.7. Property `root > hosting > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -4331,15 +3159,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ----------------------------------------------- | | [item 0](#hosting_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 9.1.7.1. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -4359,16 +3183,13 @@ for instructions on how to enable interntionalization for your site. | ----------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 9.1.7.2. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -4376,19 +3197,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.1.8. [Optional] Property root > hosting > anyOf > item 0 > predeploy - - -
+#### 9.1.8. Property `root > hosting > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -4398,15 +3207,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ---------------------------------------------- | | [item 0](#hosting_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 9.1.8.1. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -4426,16 +3231,13 @@ for instructions on how to enable interntionalization for your site. | ---------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 9.1.8.2. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -4443,19 +3245,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.1.9. [Optional] Property root > hosting > anyOf > item 0 > public - - -
+#### 9.1.9. Property `root > hosting > anyOf > item 0 > public` | | | | ------------ | -------- | @@ -4464,15 +3254,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -
-
- -
- - 9.1.10. [Optional] Property root > hosting > anyOf > item 0 > redirects - - -
+#### 9.1.10. Property `root > hosting > anyOf > item 0 > redirects` | | | | ------------ | ------- | @@ -4493,7 +3275,7 @@ for instructions on how to enable interntionalization for your site. | ----------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -##### 9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects +##### 9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects | | | | ------------------------- | ------------------------------ | @@ -4504,16 +3286,12 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -
- | Any of(Option) | | ---------------------------------------------------- | | [item 0](#hosting_anyOf_i0_redirects_items_anyOf_i0) | | [item 1](#hosting_anyOf_i0_redirects_items_anyOf_i1) | | [item 2](#hosting_anyOf_i0_redirects_items_anyOf_i2) | -
- ###### 9.1.10.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0` | | | @@ -4522,12 +3300,13 @@ for instructions on how to enable interntionalization for your site. | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.10.1.1.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i0_destination ) | No | string | No | - | The destination to redirect to. | +| + [glob](#hosting_anyOf_i0_redirects_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i0_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | - -
+###### 9.1.10.1.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination` | | | | ------------ | -------- | @@ -4536,15 +3315,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The destination to redirect to. -
-
- -
- - 9.1.10.1.1.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob - - -
+###### 9.1.10.1.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob` | | | | ------------ | -------- | @@ -4553,15 +3324,7 @@ for instructions on how to enable interntionalization for your site. **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.10.1.1.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type - - -
+###### 9.1.10.1.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type` | | | | ------------ | ------------------- | @@ -4575,12 +3338,6 @@ Must be one of: * 301 * 302 -
-
- -
-
- ###### 9.1.10.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1` | | | @@ -4589,12 +3346,13 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.10.1.2.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i1_destination ) | No | string | No | - | The destination to redirect to. | +| + [source](#hosting_anyOf_i0_redirects_items_anyOf_i1_source ) | No | string | No | - | A file path that this setting should apply to. | +| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i1_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | - -
+###### 9.1.10.1.2.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination` | | | | ------------ | -------- | @@ -4603,15 +3361,7 @@ Must be one of: **Description:** The destination to redirect to. -
-
- -
- - 9.1.10.1.2.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source - - -
+###### 9.1.10.1.2.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source` | | | | ------------ | -------- | @@ -4620,15 +3370,7 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
- - 9.1.10.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type - - -
+###### 9.1.10.1.2.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type` | | | | ------------ | ------------------- | @@ -4642,12 +3384,6 @@ Must be one of: * 301 * 302 -
-
- -
-
- ###### 9.1.10.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2` | | | @@ -4656,12 +3392,13 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.10.1.3.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i2_destination ) | No | string | No | - | The destination to redirect to. | +| + [regex](#hosting_anyOf_i0_redirects_items_anyOf_i2_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i2_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | - -
+###### 9.1.10.1.3.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination` | | | | ------------ | -------- | @@ -4670,15 +3407,7 @@ Must be one of: **Description:** The destination to redirect to. -
-
- -
- - 9.1.10.1.3.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex - - -
+###### 9.1.10.1.3.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex` | | | | ------------ | -------- | @@ -4687,15 +3416,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- - 9.1.10.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type - - -
+###### 9.1.10.1.3.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type` | | | | ------------ | ------------------- | @@ -4709,22 +3430,7 @@ Must be one of: * 301 * 302 -
-
- -
- -
- -
-
- -
- - 9.1.11. [Optional] Property root > hosting > anyOf > item 0 > rewrites - - -
+#### 9.1.11. Property `root > hosting > anyOf > item 0 > rewrites` | | | | ------------ | ------- | @@ -4745,7 +3451,7 @@ Must be one of: | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -##### 9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites +##### 9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites | | | | ------------------------- | ----------------------------- | @@ -4756,8 +3462,6 @@ Must be one of: **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -
- | Any of(Option) | | ----------------------------------------------------- | | [item 0](#hosting_anyOf_i0_rewrites_items_anyOf_i0) | @@ -4776,8 +3480,6 @@ Must be one of: | [item 13](#hosting_anyOf_i0_rewrites_items_anyOf_i13) | | [item 14](#hosting_anyOf_i0_rewrites_items_anyOf_i14) | -
- ###### 9.1.11.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0` | | | @@ -4786,27 +3488,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i0_destination ) | No | string | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | - -
+###### 9.1.11.1.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination` | | | | ------------ | -------- | | **Type** | `string` | -| **Required** | Yes | - -
-
- -
- - 9.1.11.1.1.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob +| **Required** | Yes | - -
+###### 9.1.11.1.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob` | | | | ------------ | -------- | @@ -4815,12 +3509,6 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1` | | | @@ -4829,27 +3517,20 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.2.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i1_function ) | No | string | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i1_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i1_region ) | No | string | No | - | - | - -
+###### 9.1.11.1.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.2.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob - - -
+###### 9.1.11.1.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob` | | | | ------------ | -------- | @@ -4858,27 +3539,13 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.11.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region - - -
+###### 9.1.11.1.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- ###### 9.1.11.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2` | | | @@ -4887,12 +3554,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.3.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function ) | No | object | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i2_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | - -
+###### 9.1.11.1.3.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function` | | | | ------------------------- | ----------- | @@ -4900,12 +3567,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.3.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | +| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_region ) | No | string | No | - | - | - -
+###### 9.1.11.1.3.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId` | | | | ------------ | -------- | @@ -4914,15 +3582,7 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -
-
- -
- - 9.1.11.1.3.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag - - -
+###### 9.1.11.1.3.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag` | | | | ------------ | --------- | @@ -4931,33 +3591,14 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -
-
- -
- - 9.1.11.1.3.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region - - -
+###### 9.1.11.1.3.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- -
- - 9.1.11.1.3.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob - - -
+###### 9.1.11.1.3.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob` | | | | ------------ | -------- | @@ -4966,12 +3607,6 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.4. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3` | | | @@ -4980,12 +3615,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.4.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i3_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run ) | No | object | No | - | - | - -
+###### 9.1.11.1.4.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob` | | | | ------------ | -------- | @@ -4994,15 +3629,7 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.11.1.4.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run - - -
+###### 9.1.11.1.4.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run` | | | | ------------------------- | ----------- | @@ -5010,12 +3637,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.4.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_region ) | No | string | No | - | - | +| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | - -
+###### 9.1.11.1.4.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag` | | | | ------------ | --------- | @@ -5024,30 +3652,14 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -
-
- -
- - 9.1.11.1.4.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region - - -
+###### 9.1.11.1.4.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.4.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId - - -
+###### 9.1.11.1.4.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId` | | | | ------------ | -------- | @@ -5056,15 +3668,6 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. -
-
- -
-
- -
-
- ###### 9.1.11.1.5. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4` | | | @@ -5073,27 +3676,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.5.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i4_dynamicLinks ) | No | boolean | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i4_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | - -
+###### 9.1.11.1.5.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.5.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob - - -
+###### 9.1.11.1.5.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob` | | | | ------------ | -------- | @@ -5102,12 +3697,6 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.6. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5` | | | @@ -5116,27 +3705,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.6.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i5_destination ) | No | string | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i5_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.6.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.6.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source - - -
+###### 9.1.11.1.6.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source` | | | | ------------ | -------- | @@ -5145,12 +3726,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.7. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6` | | | @@ -5159,42 +3734,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.7.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i6_function ) | No | string | No | - | - | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i6_region ) | No | string | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i6_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.7.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.7.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region - - -
+###### 9.1.11.1.7.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.7.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source - - -
+###### 9.1.11.1.7.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source` | | | | ------------ | -------- | @@ -5203,12 +3763,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.8. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7` | | | @@ -5217,12 +3771,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.8.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function ) | No | object | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i7_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.8.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function` | | | | ------------------------- | ----------- | @@ -5230,12 +3784,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.8.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | +| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_region ) | No | string | No | - | - | - -
+###### 9.1.11.1.8.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId` | | | | ------------ | -------- | @@ -5244,15 +3799,7 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -
-
- -
- - 9.1.11.1.8.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag - - -
+###### 9.1.11.1.8.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag` | | | | ------------ | --------- | @@ -5261,33 +3808,14 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -
-
- -
- - 9.1.11.1.8.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region - - -
+###### 9.1.11.1.8.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- -
- - 9.1.11.1.8.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source - - -
+###### 9.1.11.1.8.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source` | | | | ------------ | -------- | @@ -5296,12 +3824,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.9. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8` | | | @@ -5310,12 +3832,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.9.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run ) | No | object | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i8_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.9.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run` | | | | ------------------------- | ----------- | @@ -5323,12 +3845,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.9.1.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_region ) | No | string | No | - | - | +| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | - -
+###### 9.1.11.1.9.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag` | | | | ------------ | --------- | @@ -5337,30 +3860,14 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -
-
- -
- - 9.1.11.1.9.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region - - -
+###### 9.1.11.1.9.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.9.1.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId - - -
+###### 9.1.11.1.9.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId` | | | | ------------ | -------- | @@ -5369,18 +3876,7 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. -
-
- -
-
- -
- - 9.1.11.1.9.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source - - -
+###### 9.1.11.1.9.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source` | | | | ------------ | -------- | @@ -5389,12 +3885,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.10. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9` | | | @@ -5403,27 +3893,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.10.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------- | +| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i9_dynamicLinks ) | No | boolean | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i9_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.10.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.10.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source - - -
+###### 9.1.11.1.10.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source` | | | | ------------ | -------- | @@ -5432,12 +3914,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.11. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10` | | | @@ -5446,27 +3922,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.11.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i10_destination ) | No | string | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i10_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.11.1.11.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.11.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex - - -
+###### 9.1.11.1.11.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex` | | | | ------------ | -------- | @@ -5475,12 +3943,6 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
-
- ###### 9.1.11.1.12. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11` | | | @@ -5489,27 +3951,20 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.12.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i11_function ) | No | string | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i11_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i11_region ) | No | string | No | - | - | - -
+###### 9.1.11.1.12.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.12.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex - - -
+###### 9.1.11.1.12.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex` | | | | ------------ | -------- | @@ -5518,27 +3973,13 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- - 9.1.11.1.12.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region - - -
+###### 9.1.11.1.12.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- ###### 9.1.11.1.13. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12` | | | @@ -5547,12 +3988,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.13.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function ) | No | object | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i12_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.11.1.13.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function` | | | | ------------------------- | ----------- | @@ -5560,12 +4001,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.13.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | +| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_region ) | No | string | No | - | - | - -
+###### 9.1.11.1.13.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId` | | | | ------------ | -------- | @@ -5574,15 +4016,7 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -
-
- -
- - 9.1.11.1.13.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag - - -
+###### 9.1.11.1.13.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag` | | | | ------------ | --------- | @@ -5591,33 +4025,14 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -
-
- -
- - 9.1.11.1.13.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region - - -
+###### 9.1.11.1.13.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- -
- - 9.1.11.1.13.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex - - -
+###### 9.1.11.1.13.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex` | | | | ------------ | -------- | @@ -5626,12 +4041,6 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
-
- ###### 9.1.11.1.14. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13` | | | @@ -5640,12 +4049,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.14.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i13_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run ) | No | object | No | - | - | - -
+###### 9.1.11.1.14.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex` | | | | ------------ | -------- | @@ -5654,15 +4063,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- - 9.1.11.1.14.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run - - -
+###### 9.1.11.1.14.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run` | | | | ------------------------- | ----------- | @@ -5670,12 +4071,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.14.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_region ) | No | string | No | - | - | +| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | - -
+###### 9.1.11.1.14.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag` | | | | ------------ | --------- | @@ -5684,30 +4086,14 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -
-
- -
- - 9.1.11.1.14.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region - - -
+###### 9.1.11.1.14.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.14.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId - - -
+###### 9.1.11.1.14.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId` | | | | ------------ | -------- | @@ -5716,15 +4102,6 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. -
-
- -
-
- -
-
- ###### 9.1.11.1.15. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14` | | | @@ -5733,27 +4110,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.15.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i14_dynamicLinks ) | No | boolean | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i14_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.11.1.15.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.15.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex - - -
+###### 9.1.11.1.15.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex` | | | | ------------ | -------- | @@ -5762,22 +4131,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- -
- -
-
- -
- - 9.1.12. [Optional] Property root > hosting > anyOf > item 0 > site - - -
+#### 9.1.12. Property `root > hosting > anyOf > item 0 > site` | | | | ------------ | -------- | @@ -5786,15 +4140,7 @@ Must be one of: **Description:** The site to deploy. -
-
- -
- - 9.1.13. [Optional] Property root > hosting > anyOf > item 0 > source - - -
+#### 9.1.13. Property `root > hosting > anyOf > item 0 > source` | | | | ------------ | -------- | @@ -5803,15 +4149,7 @@ Must be one of: **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -
-
- -
- - 9.1.14. [Optional] Property root > hosting > anyOf > item 0 > target - - -
+#### 9.1.14. Property `root > hosting > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -5821,27 +4159,13 @@ Must be one of: **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- - 9.1.15. [Optional] Property root > hosting > anyOf > item 0 > trailingSlash - - -
+#### 9.1.15. Property `root > hosting > anyOf > item 0 > trailingSlash` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
-
- ### 9.2. Property `root > hosting > anyOf > item 1` | | | @@ -5863,7 +4187,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------- | ----------- | | [item 1 items](#hosting_anyOf_i1_items) | - | -#### 9.2.1. root > hosting > anyOf > item 1 > item 1 items +#### 9.2.1. root > hosting > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -5871,15 +4195,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Any type allowed | -
- | Any of(Option) | | ------------------------------------------ | | [item 0](#hosting_anyOf_i1_items_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1) | -
- ##### 9.2.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -5888,12 +4208,25 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.2.1.1.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [appAssociation](#hosting_anyOf_i1_items_anyOf_i0_appAssociation ) | No | enum (of string) | No | - | - | +| - [cleanUrls](#hosting_anyOf_i1_items_anyOf_i0_cleanUrls ) | No | boolean | No | - | - | +| - [frameworksBackend](#hosting_anyOf_i1_items_anyOf_i0_frameworksBackend ) | No | object | No | Same as [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | Options for this sites web frameworks backend. | +| - [headers](#hosting_anyOf_i1_items_anyOf_i0_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | +| - [i18n](#hosting_anyOf_i1_items_anyOf_i0_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | +| - [ignore](#hosting_anyOf_i1_items_anyOf_i0_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | +| - [postdeploy](#hosting_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#hosting_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [public](#hosting_anyOf_i1_items_anyOf_i0_public ) | No | string | No | - | Whether this site should publically available. | +| - [redirects](#hosting_anyOf_i1_items_anyOf_i0_redirects ) | No | array | No | - | A list of redirects for this site. | +| - [rewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites ) | No | array | No | - | A list o rewrites for this site. | +| - [site](#hosting_anyOf_i1_items_anyOf_i0_site ) | No | string | No | - | The site to deploy | +| - [source](#hosting_anyOf_i1_items_anyOf_i0_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | +| + [target](#hosting_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +| - [trailingSlash](#hosting_anyOf_i1_items_anyOf_i0_trailingSlash ) | No | boolean | No | - | - | + +###### 9.2.1.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation` | | | | ------------ | ------------------ | @@ -5904,30 +4237,14 @@ Must be one of: * "AUTO" * "NONE" -
-
- -
- - 9.2.1.1.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls - - -
+###### 9.2.1.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- - 9.2.1.1.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend - - -
+###### 9.2.1.1.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend` | | | | ------------------------- | -------------------------------------------------------- | @@ -5938,15 +4255,7 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -
-
- -
- - 9.2.1.1.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers - - -
+###### 9.2.1.1.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers` | | | | ------------ | ------- | @@ -5967,7 +4276,7 @@ Must be one of: | ---------------------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | -###### 9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders +###### 9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders | | | | ------------------------- | ----------------------------------------------------------------- | @@ -5978,15 +4287,7 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -
-
- -
- - 9.2.1.1.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n - - -
+###### 9.2.1.1.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n` | | | | ------------------------- | ----------- | @@ -5998,12 +4299,11 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -
- - 9.2.1.1.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | +| + [root](#hosting_anyOf_i1_items_anyOf_i0_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | - -
+###### 9.2.1.1.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root` | | | | ------------ | -------- | @@ -6012,18 +4312,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -
-
- -
-
- -
- - 9.2.1.1.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore - - -
+###### 9.2.1.1.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -6044,22 +4333,14 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i1_items_anyOf_i0_ignore_items) | - | -###### 9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items +###### 9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.2.1.1.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy - - -
+###### 9.2.1.1.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -6069,15 +4350,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | -
- ###### 9.2.1.1.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -6097,16 +4374,13 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.1.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -6114,19 +4388,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.1.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy - - -
+###### 9.2.1.1.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -6136,15 +4398,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | -
- ###### 9.2.1.1.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -6164,16 +4422,13 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.1.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -6181,19 +4436,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.1.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public - - -
+###### 9.2.1.1.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public` | | | | ------------ | -------- | @@ -6202,15 +4445,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -
-
- -
- - 9.2.1.1.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects - - -
+###### 9.2.1.1.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects` | | | | ------------ | ------- | @@ -6231,7 +4466,7 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -###### 9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects +###### 9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects | | | | ------------------------- | --------------------------------------------------------------------- | @@ -6242,15 +4477,7 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -
-
- -
- - 9.2.1.1.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites - - -
+###### 9.2.1.1.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites` | | | | ------------ | ------- | @@ -6271,7 +4498,7 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -###### 9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites +###### 9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites | | | | ------------------------- | ------------------------------------------------------------------- | @@ -6282,15 +4509,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -
-
- -
- - 9.2.1.1.12. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site - - -
+###### 9.2.1.1.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site` | | | | ------------ | -------- | @@ -6299,15 +4518,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The site to deploy -
-
- -
- - 9.2.1.1.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source - - -
+###### 9.2.1.1.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source` | | | | ------------ | -------- | @@ -6316,15 +4527,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -
-
- -
- - 9.2.1.1.14. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target - - -
+###### 9.2.1.1.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -6334,27 +4537,13 @@ for instructions on how to enable interntionalization for your site. **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- - 9.2.1.1.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash - - -
+###### 9.2.1.1.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
-
- ##### 9.2.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -6363,12 +4552,25 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.2.1.2.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [appAssociation](#hosting_anyOf_i1_items_anyOf_i1_appAssociation ) | No | enum (of string) | No | - | - | +| - [cleanUrls](#hosting_anyOf_i1_items_anyOf_i1_cleanUrls ) | No | boolean | No | - | - | +| - [frameworksBackend](#hosting_anyOf_i1_items_anyOf_i1_frameworksBackend ) | No | object | No | Same as [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | Options for this sites web frameworks backend. | +| - [headers](#hosting_anyOf_i1_items_anyOf_i1_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | +| - [i18n](#hosting_anyOf_i1_items_anyOf_i1_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | +| - [ignore](#hosting_anyOf_i1_items_anyOf_i1_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | +| - [postdeploy](#hosting_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#hosting_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [public](#hosting_anyOf_i1_items_anyOf_i1_public ) | No | string | No | - | Whether this site should publically available. | +| - [redirects](#hosting_anyOf_i1_items_anyOf_i1_redirects ) | No | array | No | - | A list of redirects for this site. | +| - [rewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites ) | No | array | No | - | A list o rewrites for this site. | +| + [site](#hosting_anyOf_i1_items_anyOf_i1_site ) | No | string | No | - | The site to deploy | +| - [source](#hosting_anyOf_i1_items_anyOf_i1_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | +| - [target](#hosting_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +| - [trailingSlash](#hosting_anyOf_i1_items_anyOf_i1_trailingSlash ) | No | boolean | No | - | - | + +###### 9.2.1.2.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation` | | | | ------------ | ------------------ | @@ -6379,30 +4581,14 @@ Must be one of: * "AUTO" * "NONE" -
-
- -
- - 9.2.1.2.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls - - -
+###### 9.2.1.2.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- - 9.2.1.2.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend - - -
+###### 9.2.1.2.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend` | | | | ------------------------- | -------------------------------------------------------- | @@ -6413,15 +4599,7 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -
-
- -
- - 9.2.1.2.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers - - -
+###### 9.2.1.2.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers` | | | | ------------ | ------- | @@ -6442,7 +4620,7 @@ Must be one of: | ---------------------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i1_headers_items) | Extra headers that should be sent when serving this path. | -###### 9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders +###### 9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders | | | | ------------------------- | ----------------------------------------------------------------- | @@ -6453,15 +4631,7 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -
-
- -
- - 9.2.1.2.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n - - -
+###### 9.2.1.2.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n` | | | | ------------------------- | ----------- | @@ -6473,12 +4643,11 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -
- - 9.2.1.2.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | +| + [root](#hosting_anyOf_i1_items_anyOf_i1_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | - -
+###### 9.2.1.2.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root` | | | | ------------ | -------- | @@ -6487,18 +4656,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -
-
- -
-
- -
- - 9.2.1.2.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore - - -
+###### 9.2.1.2.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore` | | | | ------------ | ----------------- | @@ -6519,22 +4677,14 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i1_items_anyOf_i1_ignore_items) | - | -###### 9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items +###### 9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.2.1.2.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy - - -
+###### 9.2.1.2.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` | | | | ------------------------- | ---------------- | @@ -6544,15 +4694,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | -
- ###### 9.2.1.2.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -6572,16 +4718,13 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.2.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -6589,19 +4732,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.2.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy - - -
+###### 9.2.1.2.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` | | | | ------------------------- | ---------------- | @@ -6611,15 +4742,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | -
- ###### 9.2.1.2.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -6639,16 +4766,13 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.2.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -6656,19 +4780,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.2.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public - - -
+###### 9.2.1.2.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public` | | | | ------------ | -------- | @@ -6677,15 +4789,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -
-
- -
- - 9.2.1.2.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects - - -
+###### 9.2.1.2.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects` | | | | ------------ | ------- | @@ -6706,7 +4810,7 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i1_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -###### 9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects +###### 9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects | | | | ------------------------- | --------------------------------------------------------------------- | @@ -6717,15 +4821,7 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -
-
- -
- - 9.2.1.2.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites - - -
+###### 9.2.1.2.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites` | | | | ------------ | ------- | @@ -6746,7 +4842,7 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -###### 9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites +###### 9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites | | | | ------------------------- | ------------------------------------------------------------------- | @@ -6757,15 +4853,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -
-
- -
- - 9.2.1.2.12. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site - - -
+###### 9.2.1.2.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site` | | | | ------------ | -------- | @@ -6774,15 +4862,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The site to deploy -
-
- -
- - 9.2.1.2.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source - - -
+###### 9.2.1.2.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source` | | | | ------------ | -------- | @@ -6791,15 +4871,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -
-
- -
- - 9.2.1.2.14. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target - - -
+###### 9.2.1.2.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target` | | | | ------------ | -------- | @@ -6809,41 +4881,14 @@ for instructions on how to enable interntionalization for your site. **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- - 9.2.1.2.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash - - -
+###### 9.2.1.2.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- -
- -
- -
- -
-
- -
- - 10. [Optional] Property root > remoteconfig - - -
+## 10. Property `root > remoteconfig` | | | | ------------------------- | -------------------------------- | @@ -6854,12 +4899,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Remote Config template(s) used by this project. -
- - 10.1. [Optional] Property root > remoteconfig > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [postdeploy](#remoteconfig_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#remoteconfig_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [template](#remoteconfig_template ) | No | string | No | - | A path to a CJSON file containing a Remote Config template. | - -
+### 10.1. Property `root > remoteconfig > postdeploy` | | | | ------------------------- | ---------------- | @@ -6869,15 +4915,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------- | | [item 0](#remoteconfig_postdeploy_anyOf_i0) | | [item 1](#remoteconfig_postdeploy_anyOf_i1) | -
- #### 10.1.1. Property `root > remoteconfig > postdeploy > anyOf > item 0` | | | @@ -6897,16 +4939,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------- | ----------- | | [item 0 items](#remoteconfig_postdeploy_anyOf_i0_items) | - | -##### 10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items +##### 10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- #### 10.1.2. Property `root > remoteconfig > postdeploy > anyOf > item 1` | | | @@ -6914,19 +4953,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 10.2. [Optional] Property root > remoteconfig > predeploy - - -
+### 10.2. Property `root > remoteconfig > predeploy` | | | | ------------------------- | ---------------- | @@ -6936,15 +4963,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------ | | [item 0](#remoteconfig_predeploy_anyOf_i0) | | [item 1](#remoteconfig_predeploy_anyOf_i1) | -
- #### 10.2.1. Property `root > remoteconfig > predeploy > anyOf > item 0` | | | @@ -6964,16 +4987,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------ | ----------- | | [item 0 items](#remoteconfig_predeploy_anyOf_i0_items) | - | -##### 10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items +##### 10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- #### 10.2.2. Property `root > remoteconfig > predeploy > anyOf > item 1` | | | @@ -6981,19 +5001,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 10.3. [Required] Property root > remoteconfig > template - - -
+### 10.3. Property `root > remoteconfig > template` | | | | ------------ | -------- | @@ -7002,18 +5010,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A path to a CJSON file containing a Remote Config template. -
-
- -
-
- -
- - 11. [Optional] Property root > storage - - -
+## 11. Property `root > storage` | | | | ------------------------- | ---------------- | @@ -7023,15 +5020,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Firebase Storage rules that should be deployed or emulated. -
- | Any of(Option) | | ---------------------------------- | | [StorageSingle](#storage_anyOf_i0) | | [item 1](#storage_anyOf_i1) | -
- ### 11.1. Property `root > storage > anyOf > StorageSingle` | | | @@ -7043,12 +5036,14 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Deployment options for a single Firebase storage bucket. -
- - 11.1.1. [Optional] Property root > storage > anyOf > item 0 > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| - [postdeploy](#storage_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#storage_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#storage_anyOf_i0_rules ) | No | string | No | - | Path to the rules files for this Firebase Storage bucket. | +| - [target](#storage_anyOf_i0_target ) | No | string | No | - | The deploy target to these Storage rules to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+#### 11.1.1. Property `root > storage > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -7058,15 +5053,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ----------------------------------------------- | | [item 0](#storage_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#storage_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 11.1.1.1. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -7086,16 +5077,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ----------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 11.1.1.2. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -7103,19 +5091,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.1.2. [Optional] Property root > storage > anyOf > item 0 > predeploy - - -
+#### 11.1.2. Property `root > storage > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -7125,15 +5101,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ---------------------------------------------- | | [item 0](#storage_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#storage_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 11.1.2.1. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -7153,16 +5125,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 11.1.2.2. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -7170,19 +5139,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.1.3. [Required] Property root > storage > anyOf > item 0 > rules - - -
+#### 11.1.3. Property `root > storage > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -7191,15 +5148,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the rules files for this Firebase Storage bucket. -
-
- -
- - 11.1.4. [Optional] Property root > storage > anyOf > item 0 > target - - -
+#### 11.1.4. Property `root > storage > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -7209,12 +5158,6 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target to these Storage rules to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
-
- ### 11.2. Property `root > storage > anyOf > item 1` | | | @@ -7236,7 +5179,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------- | ----------- | | [item 1 items](#storage_anyOf_i1_items) | - | -#### 11.2.1. root > storage > anyOf > item 1 > item 1 items +#### 11.2.1. root > storage > anyOf > item 1 > item 1 items | | | | ------------------------- | ----------- | @@ -7244,12 +5187,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 11.2.1.1. [Required] Property root > storage > anyOf > item 1 > item 1 items > bucket +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| + [bucket](#storage_anyOf_i1_items_bucket ) | No | string | No | - | The Firebase Storage bucket that this config is for. | +| - [postdeploy](#storage_anyOf_i1_items_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#storage_anyOf_i1_items_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#storage_anyOf_i1_items_rules ) | No | string | No | - | Path to the rules files for this Firebase Storage bucket. | +| - [target](#storage_anyOf_i1_items_target ) | No | string | No | - | The deploy target to these Storage rules to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+##### 11.2.1.1. Property `root > storage > anyOf > item 1 > item 1 items > bucket` | | | | ------------ | -------- | @@ -7258,15 +5204,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Firebase Storage bucket that this config is for. -
-
- -
- - 11.2.1.2. [Optional] Property root > storage > anyOf > item 1 > item 1 items > postdeploy - - -
+##### 11.2.1.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy` | | | | ------------------------- | ---------------- | @@ -7276,15 +5214,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ----------------------------------------------------- | | [item 0](#storage_anyOf_i1_items_postdeploy_anyOf_i0) | | [item 1](#storage_anyOf_i1_items_postdeploy_anyOf_i1) | -
- ###### 11.2.1.2.1. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0` | | | @@ -7304,16 +5238,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ----------------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i1_items_postdeploy_anyOf_i0_items) | - | -###### 11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items +###### 11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 11.2.1.2.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 1` | | | @@ -7321,19 +5252,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.2.1.3. [Optional] Property root > storage > anyOf > item 1 > item 1 items > predeploy - - -
+##### 11.2.1.3. Property `root > storage > anyOf > item 1 > item 1 items > predeploy` | | | | ------------------------- | ---------------- | @@ -7343,15 +5262,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ---------------------------------------------------- | | [item 0](#storage_anyOf_i1_items_predeploy_anyOf_i0) | | [item 1](#storage_anyOf_i1_items_predeploy_anyOf_i1) | -
- ###### 11.2.1.3.1. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0` | | | @@ -7371,16 +5286,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i1_items_predeploy_anyOf_i0_items) | - | -###### 11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items +###### 11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 11.2.1.3.2. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 1` | | | @@ -7388,19 +5300,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.2.1.4. [Required] Property root > storage > anyOf > item 1 > item 1 items > rules - - -
+##### 11.2.1.4. Property `root > storage > anyOf > item 1 > item 1 items > rules` | | | | ------------ | -------- | @@ -7409,15 +5309,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the rules files for this Firebase Storage bucket. -
-
- -
- - 11.2.1.5. [Optional] Property root > storage > anyOf > item 1 > item 1 items > target - - -
+##### 11.2.1.5. Property `root > storage > anyOf > item 1 > item 1 items > target` | | | | ------------ | -------- | @@ -7427,15 +5319,5 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target to these Storage rules to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- -
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:00:25 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 From e10ea196b5190d4575e0f12609cb21d9c5ea1f66 Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Tue, 17 Jun 2025 07:09:54 -0700 Subject: [PATCH 07/10] Playing with settings --- schema/docs/connector-yaml.md | 34 +-- schema/docs/dataconnect-yaml.md | 16 +- schema/docs/extension-yaml.md | 95 +------- schema/docs/firebase-config.md | 414 +------------------------------- 4 files changed, 4 insertions(+), 555 deletions(-) diff --git a/schema/docs/connector-yaml.md b/schema/docs/connector-yaml.md index e889af0c9ee..c6974330126 100644 --- a/schema/docs/connector-yaml.md +++ b/schema/docs/connector-yaml.md @@ -1,37 +1,5 @@ # Schema Docs -- [1. Property `root > connectorId`](#connectorId) -- [2. Property `root > generate`](#generate) - - [2.1. Property `root > generate > javascriptSdk`](#generate_javascriptSdk) - - [2.1.1. Property `root > generate > javascriptSdk > oneOf > javascriptSdk`](#generate_javascriptSdk_oneOf_i0) - - [2.1.1.1. Property `root > generate > javascriptSdk > oneOf > item 0 > outputDir`](#generate_javascriptSdk_oneOf_i0_outputDir) - - [2.1.1.2. Property `root > generate > javascriptSdk > oneOf > item 0 > package`](#generate_javascriptSdk_oneOf_i0_package) - - [2.1.1.3. Property `root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir`](#generate_javascriptSdk_oneOf_i0_packageJSONDir) - - [2.1.2. Property `root > generate > javascriptSdk > oneOf > item 1`](#generate_javascriptSdk_oneOf_i1) - - [2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk](#generate_javascriptSdk_oneOf_i1_items) - - [2.2. Property `root > generate > dartSdk`](#generate_dartSdk) - - [2.2.1. Property `root > generate > dartSdk > oneOf > dartSdk`](#generate_dartSdk_oneOf_i0) - - [2.2.1.1. Property `root > generate > dartSdk > oneOf > item 0 > outputDir`](#generate_dartSdk_oneOf_i0_outputDir) - - [2.2.1.2. Property `root > generate > dartSdk > oneOf > item 0 > package`](#generate_dartSdk_oneOf_i0_package) - - [2.2.2. Property `root > generate > dartSdk > oneOf > item 1`](#generate_dartSdk_oneOf_i1) - - [2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk](#generate_dartSdk_oneOf_i1_items) - - [2.3. Property `root > generate > kotlinSdk`](#generate_kotlinSdk) - - [2.3.1. Property `root > generate > kotlinSdk > oneOf > kotlinSdk`](#generate_kotlinSdk_oneOf_i0) - - [2.3.1.1. Property `root > generate > kotlinSdk > oneOf > item 0 > outputDir`](#generate_kotlinSdk_oneOf_i0_outputDir) - - [2.3.1.2. Property `root > generate > kotlinSdk > oneOf > item 0 > package`](#generate_kotlinSdk_oneOf_i0_package) - - [2.3.2. Property `root > generate > kotlinSdk > oneOf > item 1`](#generate_kotlinSdk_oneOf_i1) - - [2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk](#generate_kotlinSdk_oneOf_i1_items) - - [2.4. Property `root > generate > swiftSdk`](#generate_swiftSdk) - - [2.4.1. Property `root > generate > swiftSdk > oneOf > swiftSdk`](#generate_swiftSdk_oneOf_i0) - - [2.4.1.1. Property `root > generate > swiftSdk > oneOf > item 0 > outputDir`](#generate_swiftSdk_oneOf_i0_outputDir) - - [2.4.2. Property `root > generate > swiftSdk > oneOf > item 1`](#generate_swiftSdk_oneOf_i1) - - [2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk](#generate_swiftSdk_oneOf_i1_items) - - [2.5. Property `root > generate > llmTools`](#generate_llmTools) - - [2.5.1. Property `root > generate > llmTools > oneOf > llmTools`](#generate_llmTools_oneOf_i0) - - [2.5.1.1. Property `root > generate > llmTools > oneOf > item 0 > outputFile`](#generate_llmTools_oneOf_i0_outputFile) - - [2.5.2. Property `root > generate > llmTools > oneOf > item 1`](#generate_llmTools_oneOf_i1) - - [2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools](#generate_llmTools_oneOf_i1_items) - | | | | ------------------------- | ----------- | | **Type** | `object` | @@ -439,4 +407,4 @@ | **Same definition as** | [generate_llmTools_oneOf_i0](#generate_llmTools_oneOf_i0) | ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 diff --git a/schema/docs/dataconnect-yaml.md b/schema/docs/dataconnect-yaml.md index 6e2b236e572..1be32e8b4a9 100644 --- a/schema/docs/dataconnect-yaml.md +++ b/schema/docs/dataconnect-yaml.md @@ -1,19 +1,5 @@ # Schema Docs -- [1. Property `root > specVersion`](#specVersion) -- [2. Property `root > serviceId`](#serviceId) -- [3. Property `root > location`](#location) -- [4. Property `root > connectorDirs`](#connectorDirs) - - [4.1. root > connectorDirs > connectorDirs items](#connectorDirs_items) -- [5. Property `root > schema`](#schema) - - [5.1. Property `root > schema > source`](#schema_source) - - [5.2. Property `root > schema > datasource`](#schema_datasource) - - [5.2.1. Property `root > schema > datasource > postgresql`](#schema_datasource_postgresql) - - [5.2.1.1. Property `root > schema > datasource > postgresql > database`](#schema_datasource_postgresql_database) - - [5.2.1.2. Property `root > schema > datasource > postgresql > cloudSql`](#schema_datasource_postgresql_cloudSql) - - [5.2.1.2.1. Property `root > schema > datasource > postgresql > cloudSql > instanceId`](#schema_datasource_postgresql_cloudSql_instanceId) - - [5.2.1.2.2. Property `root > schema > datasource > postgresql > cloudSql > schemaValidation`](#schema_datasource_postgresql_cloudSql_schemaValidation) - | | | | ------------------------- | ----------- | | **Type** | `object` | @@ -180,4 +166,4 @@ Must be one of: * "STRICT" ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 diff --git a/schema/docs/extension-yaml.md b/schema/docs/extension-yaml.md index 0a9bddec2d0..8e920f66083 100644 --- a/schema/docs/extension-yaml.md +++ b/schema/docs/extension-yaml.md @@ -1,98 +1,5 @@ # Schema Docs -- [1. Property `root > name`](#name) -- [2. Property `root > version`](#version) -- [3. Property `root > specVersion`](#specVersion) -- [4. Property `root > license`](#license) -- [5. Property `root > displayName`](#displayName) -- [6. Property `root > description`](#description) -- [7. Property `root > icon`](#icon) -- [8. Property `root > billingRequired`](#billingRequired) -- [9. Property `root > tags`](#tags) - - [9.1. root > tags > tags items](#tags_items) -- [10. Property `root > sourceUrl`](#sourceUrl) -- [11. Property `root > releaseNotesUrl`](#releaseNotesUrl) -- [12. Property `root > author`](#author) - - [12.1. Property `root > author > authorName`](#author_authorName) - - [12.2. Property `root > author > email`](#author_email) - - [12.3. Property `root > author > url`](#author_url) -- [13. Property `root > contributors`](#contributors) - - [13.1. root > contributors > author](#contributors_items) -- [14. Property `root > apis`](#apis) - - [14.1. root > apis > api](#apis_items) - - [14.1.1. Property `root > apis > apis items > apiName`](#apis_items_apiName) - - [14.1.2. Property `root > apis > apis items > reason`](#apis_items_reason) -- [15. Property `root > roles`](#roles) - - [15.1. root > roles > role](#roles_items) - - [15.1.1. Property `root > roles > roles items > role`](#roles_items_role) - - [15.1.2. Property `root > roles > roles items > reason`](#roles_items_reason) - - [15.1.3. Property `root > roles > roles items > resource`](#roles_items_resource) -- [16. Property `root > externalServices`](#externalServices) - - [16.1. root > externalServices > externalService](#externalServices_items) - - [16.1.1. Property `root > externalServices > externalServices items > name`](#externalServices_items_name) - - [16.1.2. Property `root > externalServices > externalServices items > pricingUri`](#externalServices_items_pricingUri) -- [17. Property `root > params`](#params) - - [17.1. root > params > param](#params_items) - - [17.1.1. Property `root > params > params items > param`](#params_items_param) - - [17.1.2. Property `root > params > params items > label`](#params_items_label) - - [17.1.3. Property `root > params > params items > description`](#params_items_description) - - [17.1.4. Property `root > params > params items > example`](#params_items_example) - - [17.1.5. Property `root > params > params items > validationRegex`](#params_items_validationRegex) - - [17.1.6. Property `root > params > params items > validationErrorMessage`](#params_items_validationErrorMessage) - - [17.1.7. Property `root > params > params items > default`](#params_items_default) - - [17.1.8. Property `root > params > params items > required`](#params_items_required) - - [17.1.9. Property `root > params > params items > immutable`](#params_items_immutable) - - [17.1.10. Property `root > params > params items > advanced`](#params_items_advanced) - - [17.1.11. Property `root > params > params items > type`](#params_items_type) - - [17.1.12. Property `root > params > params items > resourceType`](#params_items_resourceType) - - [17.1.13. Property `root > params > params items > options`](#params_items_options) - - [17.1.13.1. root > params > params items > options > paramOption](#params_items_options_items) - - [17.1.13.1.1. Property `root > params > params items > options > options items > value`](#params_items_options_items_value) - - [17.1.13.1.2. Property `root > params > params items > options > options items > label`](#params_items_options_items_label) -- [18. Property `root > resources`](#resources) - - [18.1. root > resources > resource](#resources_items) - - [18.1.1. Property `root > resources > resources items > name`](#resources_items_name) - - [18.1.2. Property `root > resources > resources items > type`](#resources_items_type) - - [18.1.3. Property `root > resources > resources items > description`](#resources_items_description) - - [18.1.4. Property `root > resources > resources items > properties`](#resources_items_properties) - - [18.1.4.1. Property `root > resources > resources items > properties > location`](#resources_items_properties_location) - - [18.1.4.2. Property `root > resources > resources items > properties > entryPoint`](#resources_items_properties_entryPoint) - - [18.1.4.3. Property `root > resources > resources items > properties > sourceDirectory`](#resources_items_properties_sourceDirectory) - - [18.1.4.4. Property `root > resources > resources items > properties > timeout`](#resources_items_properties_timeout) - - [18.1.4.5. Property `root > resources > resources items > properties > availableMemoryMb`](#resources_items_properties_availableMemoryMb) - - [18.1.4.6. Property `root > resources > resources items > properties > runtime`](#resources_items_properties_runtime) - - [18.1.4.7. Property `root > resources > resources items > properties > httpsTrigger`](#resources_items_properties_httpsTrigger) - - [18.1.4.8. Property `root > resources > resources items > properties > eventTrigger`](#resources_items_properties_eventTrigger) - - [18.1.4.8.1. Property `root > resources > resources items > properties > eventTrigger > eventType`](#resources_items_properties_eventTrigger_eventType) - - [18.1.4.8.2. Property `root > resources > resources items > properties > eventTrigger > resource`](#resources_items_properties_eventTrigger_resource) - - [18.1.4.8.3. Property `root > resources > resources items > properties > eventTrigger > eventFilters`](#resources_items_properties_eventTrigger_eventFilters) - - [18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter](#resources_items_properties_eventTrigger_eventFilters_items) - - [18.1.4.8.3.1.1. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute`](#resources_items_properties_eventTrigger_eventFilters_items_attribute) - - [18.1.4.8.3.1.2. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value`](#resources_items_properties_eventTrigger_eventFilters_items_value) - - [18.1.4.8.4. Property `root > resources > resources items > properties > eventTrigger > channel`](#resources_items_properties_eventTrigger_channel) - - [18.1.4.8.5. Property `root > resources > resources items > properties > eventTrigger > triggerRegion`](#resources_items_properties_eventTrigger_triggerRegion) - - [18.1.4.9. Property `root > resources > resources items > properties > scheduleTrigger`](#resources_items_properties_scheduleTrigger) - - [18.1.4.9.1. Property `root > resources > resources items > properties > scheduleTrigger > schedule`](#resources_items_properties_scheduleTrigger_schedule) - - [18.1.4.9.2. Property `root > resources > resources items > properties > scheduleTrigger > timeZone`](#resources_items_properties_scheduleTrigger_timeZone) - - [18.1.4.10. Property `root > resources > resources items > properties > taskQueueTrigger`](#resources_items_properties_taskQueueTrigger) - - [18.1.4.11. Property `root > resources > resources items > properties > buildConfig`](#resources_items_properties_buildConfig) - - [18.1.4.11.1. Property `root > resources > resources items > properties > buildConfig > runtime`](#resources_items_properties_buildConfig_runtime) - - [18.1.4.11.2. Property `root > resources > resources items > properties > buildConfig > entryPoint`](#resources_items_properties_buildConfig_entryPoint) - - [18.1.4.12. Property `root > resources > resources items > properties > serviceConfig`](#resources_items_properties_serviceConfig) - - [18.1.4.12.1. Property `root > resources > resources items > properties > serviceConfig > timeoutSeconds`](#resources_items_properties_serviceConfig_timeoutSeconds) - - [18.1.4.12.2. Property `root > resources > resources items > properties > serviceConfig > availableMemory`](#resources_items_properties_serviceConfig_availableMemory) -- [19. Property `root > lifecycleEvents`](#lifecycleEvents) - - [19.1. root > lifecycleEvents > lifecycleEvent](#lifecycleEvents_items) - - [19.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall`](#lifecycleEvents_items_onInstall) - - [19.1.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > function`](#lifecycleEvents_items_onInstall_function) - - [19.1.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage`](#lifecycleEvents_items_onInstall_processingMessage) - - [19.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onUpdate`](#lifecycleEvents_items_onUpdate) - - [19.1.3. Property `root > lifecycleEvents > lifecycleEvents items > onConfigure`](#lifecycleEvents_items_onConfigure) -- [20. Property `root > events`](#events) - - [20.1. root > events > event](#events_items) - - [20.1.1. Property `root > events > events items > type`](#events_items_type) - - [20.1.2. Property `root > events > events items > description`](#events_items_description) - | | | | ------------------------- | ----------- | | **Type** | `object` | @@ -1216,4 +1123,4 @@ **Description:** A description of the event ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md index 95ba3d6da3e..759ecdf4c43 100644 --- a/schema/docs/firebase-config.md +++ b/schema/docs/firebase-config.md @@ -1,417 +1,5 @@ # Schema Docs -- [1. Property `root > $schema`](#schema) -- [2. Property `root > apphosting`](#apphosting) - - [2.1. Property `root > apphosting > anyOf > item 0`](#apphosting_anyOf_i0) - - [2.1.1. Property `root > apphosting > anyOf > item 0 > alwaysDeployFromSource`](#apphosting_anyOf_i0_alwaysDeployFromSource) - - [2.1.2. Property `root > apphosting > anyOf > item 0 > backendId`](#apphosting_anyOf_i0_backendId) - - [2.1.3. Property `root > apphosting > anyOf > item 0 > ignore`](#apphosting_anyOf_i0_ignore) - - [2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items](#apphosting_anyOf_i0_ignore_items) - - [2.1.4. Property `root > apphosting > anyOf > item 0 > rootDir`](#apphosting_anyOf_i0_rootDir) - - [2.2. Property `root > apphosting > anyOf > item 1`](#apphosting_anyOf_i1) - - [2.2.1. root > apphosting > anyOf > item 1 > item 1 items](#apphosting_anyOf_i1_items) - - [2.2.1.1. Property `root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource`](#apphosting_anyOf_i1_items_alwaysDeployFromSource) - - [2.2.1.2. Property `root > apphosting > anyOf > item 1 > item 1 items > backendId`](#apphosting_anyOf_i1_items_backendId) - - [2.2.1.3. Property `root > apphosting > anyOf > item 1 > item 1 items > ignore`](#apphosting_anyOf_i1_items_ignore) - - [2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items](#apphosting_anyOf_i1_items_ignore_items) - - [2.2.1.4. Property `root > apphosting > anyOf > item 1 > item 1 items > rootDir`](#apphosting_anyOf_i1_items_rootDir) -- [3. Property `root > database`](#database) - - [3.1. Property `root > database > anyOf > DatabaseSingle`](#database_anyOf_i0) - - [3.1.1. Property `root > database > anyOf > item 0 > postdeploy`](#database_anyOf_i0_postdeploy) - - [3.1.1.1. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 0`](#database_anyOf_i0_postdeploy_anyOf_i0) - - [3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#database_anyOf_i0_postdeploy_anyOf_i0_items) - - [3.1.1.2. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 1`](#database_anyOf_i0_postdeploy_anyOf_i1) - - [3.1.2. Property `root > database > anyOf > item 0 > predeploy`](#database_anyOf_i0_predeploy) - - [3.1.2.1. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 0`](#database_anyOf_i0_predeploy_anyOf_i0) - - [3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#database_anyOf_i0_predeploy_anyOf_i0_items) - - [3.1.2.2. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 1`](#database_anyOf_i0_predeploy_anyOf_i1) - - [3.1.3. Property `root > database > anyOf > item 0 > rules`](#database_anyOf_i0_rules) - - [3.2. Property `root > database > anyOf > item 1`](#database_anyOf_i1) - - [3.2.1. root > database > anyOf > item 1 > item 1 items](#database_anyOf_i1_items) - - [3.2.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0) - - [3.2.1.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance`](#database_anyOf_i1_items_anyOf_i0_instance) - - [3.2.1.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy`](#database_anyOf_i1_items_anyOf_i0_postdeploy) - - [3.2.1.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) - - [3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) - - [3.2.1.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) - - [3.2.1.1.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy`](#database_anyOf_i1_items_anyOf_i0_predeploy) - - [3.2.1.1.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) - - [3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) - - [3.2.1.1.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) - - [3.2.1.1.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules`](#database_anyOf_i1_items_anyOf_i0_rules) - - [3.2.1.1.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target`](#database_anyOf_i1_items_anyOf_i0_target) - - [3.2.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1) - - [3.2.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance`](#database_anyOf_i1_items_anyOf_i1_instance) - - [3.2.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy`](#database_anyOf_i1_items_anyOf_i1_postdeploy) - - [3.2.1.2.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) - - [3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) - - [3.2.1.2.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) - - [3.2.1.2.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy`](#database_anyOf_i1_items_anyOf_i1_predeploy) - - [3.2.1.2.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) - - [3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) - - [3.2.1.2.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) - - [3.2.1.2.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules`](#database_anyOf_i1_items_anyOf_i1_rules) - - [3.2.1.2.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target`](#database_anyOf_i1_items_anyOf_i1_target) -- [4. Property `root > dataconnect`](#dataconnect) - - [4.1. Property `root > dataconnect > anyOf > DataConnectSingle`](#dataconnect_anyOf_i0) - - [4.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy`](#dataconnect_anyOf_i0_postdeploy) - - [4.1.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0`](#dataconnect_anyOf_i0_postdeploy_anyOf_i0) - - [4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#dataconnect_anyOf_i0_postdeploy_anyOf_i0_items) - - [4.1.1.2. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 1`](#dataconnect_anyOf_i0_postdeploy_anyOf_i1) - - [4.1.2. Property `root > dataconnect > anyOf > item 0 > predeploy`](#dataconnect_anyOf_i0_predeploy) - - [4.1.2.1. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0`](#dataconnect_anyOf_i0_predeploy_anyOf_i0) - - [4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#dataconnect_anyOf_i0_predeploy_anyOf_i0_items) - - [4.1.2.2. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 1`](#dataconnect_anyOf_i0_predeploy_anyOf_i1) - - [4.1.3. Property `root > dataconnect > anyOf > item 0 > source`](#dataconnect_anyOf_i0_source) - - [4.2. Property `root > dataconnect > anyOf > item 1`](#dataconnect_anyOf_i1) - - [4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle](#dataconnect_anyOf_i1_items) -- [5. Property `root > emulators`](#emulators) - - [5.1. Property `root > emulators > apphosting`](#emulators_apphosting) - - [5.1.1. Property `root > emulators > apphosting > host`](#emulators_apphosting_host) - - [5.1.2. Property `root > emulators > apphosting > port`](#emulators_apphosting_port) - - [5.1.3. Property `root > emulators > apphosting > rootDirectory`](#emulators_apphosting_rootDirectory) - - [5.1.4. Property `root > emulators > apphosting > startCommand`](#emulators_apphosting_startCommand) - - [5.1.5. Property `root > emulators > apphosting > startCommandOverride`](#emulators_apphosting_startCommandOverride) - - [5.2. Property `root > emulators > auth`](#emulators_auth) - - [5.2.1. Property `root > emulators > auth > host`](#emulators_auth_host) - - [5.2.2. Property `root > emulators > auth > port`](#emulators_auth_port) - - [5.3. Property `root > emulators > database`](#emulators_database) - - [5.3.1. Property `root > emulators > database > host`](#emulators_database_host) - - [5.3.2. Property `root > emulators > database > port`](#emulators_database_port) - - [5.4. Property `root > emulators > dataconnect`](#emulators_dataconnect) - - [5.4.1. Property `root > emulators > dataconnect > dataDir`](#emulators_dataconnect_dataDir) - - [5.4.2. Property `root > emulators > dataconnect > host`](#emulators_dataconnect_host) - - [5.4.3. Property `root > emulators > dataconnect > port`](#emulators_dataconnect_port) - - [5.4.4. Property `root > emulators > dataconnect > postgresHost`](#emulators_dataconnect_postgresHost) - - [5.4.5. Property `root > emulators > dataconnect > postgresPort`](#emulators_dataconnect_postgresPort) - - [5.5. Property `root > emulators > eventarc`](#emulators_eventarc) - - [5.5.1. Property `root > emulators > eventarc > host`](#emulators_eventarc_host) - - [5.5.2. Property `root > emulators > eventarc > port`](#emulators_eventarc_port) - - [5.6. Property `root > emulators > extensions`](#emulators_extensions) - - [5.7. Property `root > emulators > firestore`](#emulators_firestore) - - [5.7.1. Property `root > emulators > firestore > host`](#emulators_firestore_host) - - [5.7.2. Property `root > emulators > firestore > port`](#emulators_firestore_port) - - [5.7.3. Property `root > emulators > firestore > websocketPort`](#emulators_firestore_websocketPort) - - [5.8. Property `root > emulators > hosting`](#emulators_hosting) - - [5.8.1. Property `root > emulators > hosting > host`](#emulators_hosting_host) - - [5.8.2. Property `root > emulators > hosting > port`](#emulators_hosting_port) - - [5.9. Property `root > emulators > hub`](#emulators_hub) - - [5.9.1. Property `root > emulators > hub > host`](#emulators_hub_host) - - [5.9.2. Property `root > emulators > hub > port`](#emulators_hub_port) - - [5.10. Property `root > emulators > logging`](#emulators_logging) - - [5.10.1. Property `root > emulators > logging > host`](#emulators_logging_host) - - [5.10.2. Property `root > emulators > logging > port`](#emulators_logging_port) - - [5.11. Property `root > emulators > pubsub`](#emulators_pubsub) - - [5.11.1. Property `root > emulators > pubsub > host`](#emulators_pubsub_host) - - [5.11.2. Property `root > emulators > pubsub > port`](#emulators_pubsub_port) - - [5.12. Property `root > emulators > singleProjectMode`](#emulators_singleProjectMode) - - [5.13. Property `root > emulators > storage`](#emulators_storage) - - [5.13.1. Property `root > emulators > storage > host`](#emulators_storage_host) - - [5.13.2. Property `root > emulators > storage > port`](#emulators_storage_port) - - [5.14. Property `root > emulators > tasks`](#emulators_tasks) - - [5.14.1. Property `root > emulators > tasks > host`](#emulators_tasks_host) - - [5.14.2. Property `root > emulators > tasks > port`](#emulators_tasks_port) - - [5.15. Property `root > emulators > ui`](#emulators_ui) - - [5.15.1. Property `root > emulators > ui > enabled`](#emulators_ui_enabled) - - [5.15.2. Property `root > emulators > ui > host`](#emulators_ui_host) - - [5.15.3. Property `root > emulators > ui > port`](#emulators_ui_port) -- [6. Property `root > extensions`](#extensions) -- [7. Property `root > firestore`](#firestore) - - [7.1. Property `root > firestore > anyOf > FirestoreSingle`](#firestore_anyOf_i0) - - [7.1.1. Property `root > firestore > anyOf > item 0 > database`](#firestore_anyOf_i0_database) - - [7.1.2. Property `root > firestore > anyOf > item 0 > indexes`](#firestore_anyOf_i0_indexes) - - [7.1.3. Property `root > firestore > anyOf > item 0 > location`](#firestore_anyOf_i0_location) - - [7.1.4. Property `root > firestore > anyOf > item 0 > postdeploy`](#firestore_anyOf_i0_postdeploy) - - [7.1.4.1. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0`](#firestore_anyOf_i0_postdeploy_anyOf_i0) - - [7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i0_postdeploy_anyOf_i0_items) - - [7.1.4.2. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 1`](#firestore_anyOf_i0_postdeploy_anyOf_i1) - - [7.1.5. Property `root > firestore > anyOf > item 0 > predeploy`](#firestore_anyOf_i0_predeploy) - - [7.1.5.1. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 0`](#firestore_anyOf_i0_predeploy_anyOf_i0) - - [7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i0_predeploy_anyOf_i0_items) - - [7.1.5.2. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 1`](#firestore_anyOf_i0_predeploy_anyOf_i1) - - [7.1.6. Property `root > firestore > anyOf > item 0 > rules`](#firestore_anyOf_i0_rules) - - [7.2. Property `root > firestore > anyOf > item 1`](#firestore_anyOf_i1) - - [7.2.1. root > firestore > anyOf > item 1 > item 1 items](#firestore_anyOf_i1_items) - - [7.2.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0) - - [7.2.1.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database`](#firestore_anyOf_i1_items_anyOf_i0_database) - - [7.2.1.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes`](#firestore_anyOf_i1_items_anyOf_i0_indexes) - - [7.2.1.1.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy) - - [7.2.1.1.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) - - [7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) - - [7.2.1.1.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) - - [7.2.1.1.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy`](#firestore_anyOf_i1_items_anyOf_i0_predeploy) - - [7.2.1.1.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) - - [7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) - - [7.2.1.1.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) - - [7.2.1.1.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules`](#firestore_anyOf_i1_items_anyOf_i0_rules) - - [7.2.1.1.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target`](#firestore_anyOf_i1_items_anyOf_i0_target) - - [7.2.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1) - - [7.2.1.2.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database`](#firestore_anyOf_i1_items_anyOf_i1_database) - - [7.2.1.2.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes`](#firestore_anyOf_i1_items_anyOf_i1_indexes) - - [7.2.1.2.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy) - - [7.2.1.2.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) - - [7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) - - [7.2.1.2.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) - - [7.2.1.2.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy`](#firestore_anyOf_i1_items_anyOf_i1_predeploy) - - [7.2.1.2.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) - - [7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) - - [7.2.1.2.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) - - [7.2.1.2.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules`](#firestore_anyOf_i1_items_anyOf_i1_rules) - - [7.2.1.2.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target`](#firestore_anyOf_i1_items_anyOf_i1_target) -- [8. Property `root > functions`](#functions) - - [8.1. Property `root > functions > anyOf > FunctionConfig`](#functions_anyOf_i0) - - [8.1.1. Property `root > functions > anyOf > item 0 > codebase`](#functions_anyOf_i0_codebase) - - [8.1.2. Property `root > functions > anyOf > item 0 > ignore`](#functions_anyOf_i0_ignore) - - [8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items](#functions_anyOf_i0_ignore_items) - - [8.1.3. Property `root > functions > anyOf > item 0 > postdeploy`](#functions_anyOf_i0_postdeploy) - - [8.1.3.1. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 0`](#functions_anyOf_i0_postdeploy_anyOf_i0) - - [8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#functions_anyOf_i0_postdeploy_anyOf_i0_items) - - [8.1.3.2. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 1`](#functions_anyOf_i0_postdeploy_anyOf_i1) - - [8.1.4. Property `root > functions > anyOf > item 0 > predeploy`](#functions_anyOf_i0_predeploy) - - [8.1.4.1. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 0`](#functions_anyOf_i0_predeploy_anyOf_i0) - - [8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#functions_anyOf_i0_predeploy_anyOf_i0_items) - - [8.1.4.2. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 1`](#functions_anyOf_i0_predeploy_anyOf_i1) - - [8.1.5. Property `root > functions > anyOf > item 0 > runtime`](#functions_anyOf_i0_runtime) - - [8.1.6. Property `root > functions > anyOf > item 0 > source`](#functions_anyOf_i0_source) - - [8.2. Property `root > functions > anyOf > item 1`](#functions_anyOf_i1) - - [8.2.1. root > functions > anyOf > item 1 > FunctionConfig](#functions_anyOf_i1_items) -- [9. Property `root > hosting`](#hosting) - - [9.1. Property `root > hosting > anyOf > HostingSingle`](#hosting_anyOf_i0) - - [9.1.1. Property `root > hosting > anyOf > item 0 > appAssociation`](#hosting_anyOf_i0_appAssociation) - - [9.1.2. Property `root > hosting > anyOf > item 0 > cleanUrls`](#hosting_anyOf_i0_cleanUrls) - - [9.1.3. Property `root > hosting > anyOf > item 0 > frameworksBackend`](#hosting_anyOf_i0_frameworksBackend) - - [9.1.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > concurrency`](#hosting_anyOf_i0_frameworksBackend_concurrency) - - [9.1.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cors`](#hosting_anyOf_i0_frameworksBackend_cors) - - [9.1.3.3. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu`](#hosting_anyOf_i0_frameworksBackend_cpu) - - [9.1.3.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 0`](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i0) - - [9.1.3.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 1`](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i1) - - [9.1.3.4. Property `root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck`](#hosting_anyOf_i0_frameworksBackend_enforceAppCheck) - - [9.1.3.5. Property `root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings`](#hosting_anyOf_i0_frameworksBackend_ingressSettings) - - [9.1.3.6. Property `root > hosting > anyOf > item 0 > frameworksBackend > invoker`](#hosting_anyOf_i0_frameworksBackend_invoker) - - [9.1.3.7. Property `root > hosting > anyOf > item 0 > frameworksBackend > labels`](#hosting_anyOf_i0_frameworksBackend_labels) - - [9.1.3.8. Property `root > hosting > anyOf > item 0 > frameworksBackend > maxInstances`](#hosting_anyOf_i0_frameworksBackend_maxInstances) - - [9.1.3.9. Property `root > hosting > anyOf > item 0 > frameworksBackend > memory`](#hosting_anyOf_i0_frameworksBackend_memory) - - [9.1.3.10. Property `root > hosting > anyOf > item 0 > frameworksBackend > minInstances`](#hosting_anyOf_i0_frameworksBackend_minInstances) - - [9.1.3.11. Property `root > hosting > anyOf > item 0 > frameworksBackend > omit`](#hosting_anyOf_i0_frameworksBackend_omit) - - [9.1.3.12. Property `root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges`](#hosting_anyOf_i0_frameworksBackend_preserveExternalChanges) - - [9.1.3.13. Property `root > hosting > anyOf > item 0 > frameworksBackend > region`](#hosting_anyOf_i0_frameworksBackend_region) - - [9.1.3.14. Property `root > hosting > anyOf > item 0 > frameworksBackend > secrets`](#hosting_anyOf_i0_frameworksBackend_secrets) - - [9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items](#hosting_anyOf_i0_frameworksBackend_secrets_items) - - [9.1.3.15. Property `root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount`](#hosting_anyOf_i0_frameworksBackend_serviceAccount) - - [9.1.3.16. Property `root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds`](#hosting_anyOf_i0_frameworksBackend_timeoutSeconds) - - [9.1.3.17. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector`](#hosting_anyOf_i0_frameworksBackend_vpcConnector) - - [9.1.3.18. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings`](#hosting_anyOf_i0_frameworksBackend_vpcConnectorEgressSettings) - - [9.1.4. Property `root > hosting > anyOf > item 0 > headers`](#hosting_anyOf_i0_headers) - - [9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders](#hosting_anyOf_i0_headers_items) - - [9.1.4.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0`](#hosting_anyOf_i0_headers_items_anyOf_i0) - - [9.1.4.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob`](#hosting_anyOf_i0_headers_items_anyOf_i0_glob) - - [9.1.4.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers`](#hosting_anyOf_i0_headers_items_anyOf_i0_headers) - - [9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items) - - [9.1.4.1.1.2.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key`](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_key) - - [9.1.4.1.1.2.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value`](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_value) - - [9.1.4.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1`](#hosting_anyOf_i0_headers_items_anyOf_i1) - - [9.1.4.1.2.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers`](#hosting_anyOf_i0_headers_items_anyOf_i1_headers) - - [9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items) - - [9.1.4.1.2.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key`](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_key) - - [9.1.4.1.2.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value`](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_value) - - [9.1.4.1.2.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source`](#hosting_anyOf_i0_headers_items_anyOf_i1_source) - - [9.1.4.1.3. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2`](#hosting_anyOf_i0_headers_items_anyOf_i2) - - [9.1.4.1.3.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers`](#hosting_anyOf_i0_headers_items_anyOf_i2_headers) - - [9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items) - - [9.1.4.1.3.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key`](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_key) - - [9.1.4.1.3.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value`](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_value) - - [9.1.4.1.3.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex`](#hosting_anyOf_i0_headers_items_anyOf_i2_regex) - - [9.1.5. Property `root > hosting > anyOf > item 0 > i18n`](#hosting_anyOf_i0_i18n) - - [9.1.5.1. Property `root > hosting > anyOf > item 0 > i18n > root`](#hosting_anyOf_i0_i18n_root) - - [9.1.6. Property `root > hosting > anyOf > item 0 > ignore`](#hosting_anyOf_i0_ignore) - - [9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items](#hosting_anyOf_i0_ignore_items) - - [9.1.7. Property `root > hosting > anyOf > item 0 > postdeploy`](#hosting_anyOf_i0_postdeploy) - - [9.1.7.1. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0`](#hosting_anyOf_i0_postdeploy_anyOf_i0) - - [9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i0_postdeploy_anyOf_i0_items) - - [9.1.7.2. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 1`](#hosting_anyOf_i0_postdeploy_anyOf_i1) - - [9.1.8. Property `root > hosting > anyOf > item 0 > predeploy`](#hosting_anyOf_i0_predeploy) - - [9.1.8.1. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 0`](#hosting_anyOf_i0_predeploy_anyOf_i0) - - [9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i0_predeploy_anyOf_i0_items) - - [9.1.8.2. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 1`](#hosting_anyOf_i0_predeploy_anyOf_i1) - - [9.1.9. Property `root > hosting > anyOf > item 0 > public`](#hosting_anyOf_i0_public) - - [9.1.10. Property `root > hosting > anyOf > item 0 > redirects`](#hosting_anyOf_i0_redirects) - - [9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects](#hosting_anyOf_i0_redirects_items) - - [9.1.10.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0`](#hosting_anyOf_i0_redirects_items_anyOf_i0) - - [9.1.10.1.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination`](#hosting_anyOf_i0_redirects_items_anyOf_i0_destination) - - [9.1.10.1.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob`](#hosting_anyOf_i0_redirects_items_anyOf_i0_glob) - - [9.1.10.1.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type`](#hosting_anyOf_i0_redirects_items_anyOf_i0_type) - - [9.1.10.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1`](#hosting_anyOf_i0_redirects_items_anyOf_i1) - - [9.1.10.1.2.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination`](#hosting_anyOf_i0_redirects_items_anyOf_i1_destination) - - [9.1.10.1.2.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source`](#hosting_anyOf_i0_redirects_items_anyOf_i1_source) - - [9.1.10.1.2.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type`](#hosting_anyOf_i0_redirects_items_anyOf_i1_type) - - [9.1.10.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2`](#hosting_anyOf_i0_redirects_items_anyOf_i2) - - [9.1.10.1.3.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination`](#hosting_anyOf_i0_redirects_items_anyOf_i2_destination) - - [9.1.10.1.3.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex`](#hosting_anyOf_i0_redirects_items_anyOf_i2_regex) - - [9.1.10.1.3.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type`](#hosting_anyOf_i0_redirects_items_anyOf_i2_type) - - [9.1.11. Property `root > hosting > anyOf > item 0 > rewrites`](#hosting_anyOf_i0_rewrites) - - [9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites](#hosting_anyOf_i0_rewrites_items) - - [9.1.11.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0`](#hosting_anyOf_i0_rewrites_items_anyOf_i0) - - [9.1.11.1.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination`](#hosting_anyOf_i0_rewrites_items_anyOf_i0_destination) - - [9.1.11.1.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i0_glob) - - [9.1.11.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1`](#hosting_anyOf_i0_rewrites_items_anyOf_i1) - - [9.1.11.1.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i1_function) - - [9.1.11.1.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i1_glob) - - [9.1.11.1.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i1_region) - - [9.1.11.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2`](#hosting_anyOf_i0_rewrites_items_anyOf_i2) - - [9.1.11.1.3.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function) - - [9.1.11.1.3.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_functionId) - - [9.1.11.1.3.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_pinTag) - - [9.1.11.1.3.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_region) - - [9.1.11.1.3.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i2_glob) - - [9.1.11.1.4. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3`](#hosting_anyOf_i0_rewrites_items_anyOf_i3) - - [9.1.11.1.4.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_glob) - - [9.1.11.1.4.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run) - - [9.1.11.1.4.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_pinTag) - - [9.1.11.1.4.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_region) - - [9.1.11.1.4.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId`](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_serviceId) - - [9.1.11.1.5. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4`](#hosting_anyOf_i0_rewrites_items_anyOf_i4) - - [9.1.11.1.5.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks`](#hosting_anyOf_i0_rewrites_items_anyOf_i4_dynamicLinks) - - [9.1.11.1.5.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob`](#hosting_anyOf_i0_rewrites_items_anyOf_i4_glob) - - [9.1.11.1.6. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5`](#hosting_anyOf_i0_rewrites_items_anyOf_i5) - - [9.1.11.1.6.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination`](#hosting_anyOf_i0_rewrites_items_anyOf_i5_destination) - - [9.1.11.1.6.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i5_source) - - [9.1.11.1.7. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6`](#hosting_anyOf_i0_rewrites_items_anyOf_i6) - - [9.1.11.1.7.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i6_function) - - [9.1.11.1.7.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i6_region) - - [9.1.11.1.7.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i6_source) - - [9.1.11.1.8. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7`](#hosting_anyOf_i0_rewrites_items_anyOf_i7) - - [9.1.11.1.8.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function) - - [9.1.11.1.8.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_functionId) - - [9.1.11.1.8.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_pinTag) - - [9.1.11.1.8.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_region) - - [9.1.11.1.8.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i7_source) - - [9.1.11.1.9. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8`](#hosting_anyOf_i0_rewrites_items_anyOf_i8) - - [9.1.11.1.9.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run) - - [9.1.11.1.9.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_pinTag) - - [9.1.11.1.9.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_region) - - [9.1.11.1.9.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_serviceId) - - [9.1.11.1.9.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i8_source) - - [9.1.11.1.10. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9`](#hosting_anyOf_i0_rewrites_items_anyOf_i9) - - [9.1.11.1.10.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks`](#hosting_anyOf_i0_rewrites_items_anyOf_i9_dynamicLinks) - - [9.1.11.1.10.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source`](#hosting_anyOf_i0_rewrites_items_anyOf_i9_source) - - [9.1.11.1.11. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10`](#hosting_anyOf_i0_rewrites_items_anyOf_i10) - - [9.1.11.1.11.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination`](#hosting_anyOf_i0_rewrites_items_anyOf_i10_destination) - - [9.1.11.1.11.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i10_regex) - - [9.1.11.1.12. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11`](#hosting_anyOf_i0_rewrites_items_anyOf_i11) - - [9.1.11.1.12.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i11_function) - - [9.1.11.1.12.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i11_regex) - - [9.1.11.1.12.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i11_region) - - [9.1.11.1.13. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12`](#hosting_anyOf_i0_rewrites_items_anyOf_i12) - - [9.1.11.1.13.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function) - - [9.1.11.1.13.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_functionId) - - [9.1.11.1.13.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_pinTag) - - [9.1.11.1.13.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_region) - - [9.1.11.1.13.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i12_regex) - - [9.1.11.1.14. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13`](#hosting_anyOf_i0_rewrites_items_anyOf_i13) - - [9.1.11.1.14.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_regex) - - [9.1.11.1.14.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run) - - [9.1.11.1.14.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_pinTag) - - [9.1.11.1.14.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_region) - - [9.1.11.1.14.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId`](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_serviceId) - - [9.1.11.1.15. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14`](#hosting_anyOf_i0_rewrites_items_anyOf_i14) - - [9.1.11.1.15.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks`](#hosting_anyOf_i0_rewrites_items_anyOf_i14_dynamicLinks) - - [9.1.11.1.15.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex`](#hosting_anyOf_i0_rewrites_items_anyOf_i14_regex) - - [9.1.12. Property `root > hosting > anyOf > item 0 > site`](#hosting_anyOf_i0_site) - - [9.1.13. Property `root > hosting > anyOf > item 0 > source`](#hosting_anyOf_i0_source) - - [9.1.14. Property `root > hosting > anyOf > item 0 > target`](#hosting_anyOf_i0_target) - - [9.1.15. Property `root > hosting > anyOf > item 0 > trailingSlash`](#hosting_anyOf_i0_trailingSlash) - - [9.2. Property `root > hosting > anyOf > item 1`](#hosting_anyOf_i1) - - [9.2.1. root > hosting > anyOf > item 1 > item 1 items](#hosting_anyOf_i1_items) - - [9.2.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0) - - [9.2.1.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation`](#hosting_anyOf_i1_items_anyOf_i0_appAssociation) - - [9.2.1.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls`](#hosting_anyOf_i1_items_anyOf_i0_cleanUrls) - - [9.2.1.1.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend`](#hosting_anyOf_i1_items_anyOf_i0_frameworksBackend) - - [9.2.1.1.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers`](#hosting_anyOf_i1_items_anyOf_i0_headers) - - [9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders](#hosting_anyOf_i1_items_anyOf_i0_headers_items) - - [9.2.1.1.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n`](#hosting_anyOf_i1_items_anyOf_i0_i18n) - - [9.2.1.1.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root`](#hosting_anyOf_i1_items_anyOf_i0_i18n_root) - - [9.2.1.1.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore`](#hosting_anyOf_i1_items_anyOf_i0_ignore) - - [9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items](#hosting_anyOf_i1_items_anyOf_i0_ignore_items) - - [9.2.1.1.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy) - - [9.2.1.1.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) - - [9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) - - [9.2.1.1.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) - - [9.2.1.1.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy`](#hosting_anyOf_i1_items_anyOf_i0_predeploy) - - [9.2.1.1.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) - - [9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) - - [9.2.1.1.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) - - [9.2.1.1.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public`](#hosting_anyOf_i1_items_anyOf_i0_public) - - [9.2.1.1.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects`](#hosting_anyOf_i1_items_anyOf_i0_redirects) - - [9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects](#hosting_anyOf_i1_items_anyOf_i0_redirects_items) - - [9.2.1.1.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites`](#hosting_anyOf_i1_items_anyOf_i0_rewrites) - - [9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites_items) - - [9.2.1.1.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site`](#hosting_anyOf_i1_items_anyOf_i0_site) - - [9.2.1.1.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source`](#hosting_anyOf_i1_items_anyOf_i0_source) - - [9.2.1.1.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target`](#hosting_anyOf_i1_items_anyOf_i0_target) - - [9.2.1.1.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash`](#hosting_anyOf_i1_items_anyOf_i0_trailingSlash) - - [9.2.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1) - - [9.2.1.2.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation`](#hosting_anyOf_i1_items_anyOf_i1_appAssociation) - - [9.2.1.2.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls`](#hosting_anyOf_i1_items_anyOf_i1_cleanUrls) - - [9.2.1.2.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend`](#hosting_anyOf_i1_items_anyOf_i1_frameworksBackend) - - [9.2.1.2.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers`](#hosting_anyOf_i1_items_anyOf_i1_headers) - - [9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders](#hosting_anyOf_i1_items_anyOf_i1_headers_items) - - [9.2.1.2.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n`](#hosting_anyOf_i1_items_anyOf_i1_i18n) - - [9.2.1.2.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root`](#hosting_anyOf_i1_items_anyOf_i1_i18n_root) - - [9.2.1.2.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore`](#hosting_anyOf_i1_items_anyOf_i1_ignore) - - [9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items](#hosting_anyOf_i1_items_anyOf_i1_ignore_items) - - [9.2.1.2.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy) - - [9.2.1.2.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) - - [9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) - - [9.2.1.2.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) - - [9.2.1.2.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy`](#hosting_anyOf_i1_items_anyOf_i1_predeploy) - - [9.2.1.2.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0`](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) - - [9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) - - [9.2.1.2.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1`](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) - - [9.2.1.2.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public`](#hosting_anyOf_i1_items_anyOf_i1_public) - - [9.2.1.2.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects`](#hosting_anyOf_i1_items_anyOf_i1_redirects) - - [9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects](#hosting_anyOf_i1_items_anyOf_i1_redirects_items) - - [9.2.1.2.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites`](#hosting_anyOf_i1_items_anyOf_i1_rewrites) - - [9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites_items) - - [9.2.1.2.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site`](#hosting_anyOf_i1_items_anyOf_i1_site) - - [9.2.1.2.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source`](#hosting_anyOf_i1_items_anyOf_i1_source) - - [9.2.1.2.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target`](#hosting_anyOf_i1_items_anyOf_i1_target) - - [9.2.1.2.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash`](#hosting_anyOf_i1_items_anyOf_i1_trailingSlash) -- [10. Property `root > remoteconfig`](#remoteconfig) - - [10.1. Property `root > remoteconfig > postdeploy`](#remoteconfig_postdeploy) - - [10.1.1. Property `root > remoteconfig > postdeploy > anyOf > item 0`](#remoteconfig_postdeploy_anyOf_i0) - - [10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items](#remoteconfig_postdeploy_anyOf_i0_items) - - [10.1.2. Property `root > remoteconfig > postdeploy > anyOf > item 1`](#remoteconfig_postdeploy_anyOf_i1) - - [10.2. Property `root > remoteconfig > predeploy`](#remoteconfig_predeploy) - - [10.2.1. Property `root > remoteconfig > predeploy > anyOf > item 0`](#remoteconfig_predeploy_anyOf_i0) - - [10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items](#remoteconfig_predeploy_anyOf_i0_items) - - [10.2.2. Property `root > remoteconfig > predeploy > anyOf > item 1`](#remoteconfig_predeploy_anyOf_i1) - - [10.3. Property `root > remoteconfig > template`](#remoteconfig_template) -- [11. Property `root > storage`](#storage) - - [11.1. Property `root > storage > anyOf > StorageSingle`](#storage_anyOf_i0) - - [11.1.1. Property `root > storage > anyOf > item 0 > postdeploy`](#storage_anyOf_i0_postdeploy) - - [11.1.1.1. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 0`](#storage_anyOf_i0_postdeploy_anyOf_i0) - - [11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i0_postdeploy_anyOf_i0_items) - - [11.1.1.2. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 1`](#storage_anyOf_i0_postdeploy_anyOf_i1) - - [11.1.2. Property `root > storage > anyOf > item 0 > predeploy`](#storage_anyOf_i0_predeploy) - - [11.1.2.1. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 0`](#storage_anyOf_i0_predeploy_anyOf_i0) - - [11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i0_predeploy_anyOf_i0_items) - - [11.1.2.2. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 1`](#storage_anyOf_i0_predeploy_anyOf_i1) - - [11.1.3. Property `root > storage > anyOf > item 0 > rules`](#storage_anyOf_i0_rules) - - [11.1.4. Property `root > storage > anyOf > item 0 > target`](#storage_anyOf_i0_target) - - [11.2. Property `root > storage > anyOf > item 1`](#storage_anyOf_i1) - - [11.2.1. root > storage > anyOf > item 1 > item 1 items](#storage_anyOf_i1_items) - - [11.2.1.1. Property `root > storage > anyOf > item 1 > item 1 items > bucket`](#storage_anyOf_i1_items_bucket) - - [11.2.1.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy`](#storage_anyOf_i1_items_postdeploy) - - [11.2.1.2.1. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0`](#storage_anyOf_i1_items_postdeploy_anyOf_i0) - - [11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i1_items_postdeploy_anyOf_i0_items) - - [11.2.1.2.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 1`](#storage_anyOf_i1_items_postdeploy_anyOf_i1) - - [11.2.1.3. Property `root > storage > anyOf > item 1 > item 1 items > predeploy`](#storage_anyOf_i1_items_predeploy) - - [11.2.1.3.1. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0`](#storage_anyOf_i1_items_predeploy_anyOf_i0) - - [11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items](#storage_anyOf_i1_items_predeploy_anyOf_i0_items) - - [11.2.1.3.2. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 1`](#storage_anyOf_i1_items_predeploy_anyOf_i1) - - [11.2.1.4. Property `root > storage > anyOf > item 1 > item 1 items > rules`](#storage_anyOf_i1_items_rules) - - [11.2.1.5. Property `root > storage > anyOf > item 1 > item 1 items > target`](#storage_anyOf_i1_items_target) - | | | | ------------------------- | ----------- | | **Type** | `object` | @@ -5320,4 +4908,4 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:03:18 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 From 1102cd876da5ff3862c7333509c1b565f9d2b511 Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Tue, 17 Jun 2025 07:11:28 -0700 Subject: [PATCH 08/10] Non nested MD --- schema/docs/connector-yaml.md | 255 ++- schema/docs/dataconnect-yaml.md | 141 +- schema/docs/extension-yaml.md | 939 ++++++-- schema/docs/firebase-config.md | 3530 ++++++++++++++++++++++++------- 4 files changed, 3854 insertions(+), 1011 deletions(-) diff --git a/schema/docs/connector-yaml.md b/schema/docs/connector-yaml.md index c6974330126..61ca18cfaca 100644 --- a/schema/docs/connector-yaml.md +++ b/schema/docs/connector-yaml.md @@ -8,12 +8,12 @@ **Description:** connector.yaml is how you configure a connector for your Firebase Data Connect service. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------ | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | -| - [connectorId](#connectorId ) | No | string | No | - | The ID of the Firebase Data Connect connector. | -| - [generate](#generate ) | No | object | No | - | - | +
+ + 1. [Optional] Property root > connectorId -## 1. Property `root > connectorId` + +
| | | | ------------ | -------- | @@ -22,7 +22,15 @@ **Description:** The ID of the Firebase Data Connect connector. -## 2. Property `root > generate` +
+
+ +
+ + 2. [Optional] Property root > generate + + +
| | | | ------------------------- | ----------- | @@ -30,15 +38,12 @@ | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------- | -| - [javascriptSdk](#generate_javascriptSdk ) | No | Combination | No | - | Configuration for a generated Javascript SDK | -| - [dartSdk](#generate_dartSdk ) | No | Combination | No | - | Configuration for a generated Dart SDK | -| - [kotlinSdk](#generate_kotlinSdk ) | No | Combination | No | - | Configuration for a generated Kotlin SDK | -| - [swiftSdk](#generate_swiftSdk ) | No | Combination | No | - | Configuration for a generated Swift SDK | -| - [llmTools](#generate_llmTools ) | No | Combination | No | - | - | +
+ + 2.1. [Optional] Property root > generate > javascriptSdk -### 2.1. Property `root > generate > javascriptSdk` + +
| | | | ------------------------- | ---------------- | @@ -48,11 +53,15 @@ **Description:** Configuration for a generated Javascript SDK +
+ | One of(Option) | | ------------------------------------------------- | | [javascriptSdk](#generate_javascriptSdk_oneOf_i0) | | [item 1](#generate_javascriptSdk_oneOf_i1) | +
+ #### 2.1.1. Property `root > generate > javascriptSdk > oneOf > javascriptSdk` | | | @@ -62,14 +71,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/javascriptSdk | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------- | -| - [outputDir](#generate_javascriptSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | -| - [package](#generate_javascriptSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | -| - [packageJSONDir](#generate_javascriptSdk_oneOf_i0_packageJSONDir ) | No | string | No | - | The directory containining the package.json to install the generated package in. | -| - [](#generate_javascriptSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | +
+ + 2.1.1.1. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > outputDir -##### 2.1.1.1. Property `root > generate > javascriptSdk > oneOf > item 0 > outputDir` + +
| | | | ------------ | -------- | @@ -78,7 +85,15 @@ **Description:** Path to the directory where generated files should be written to. -##### 2.1.1.2. Property `root > generate > javascriptSdk > oneOf > item 0 > package` +
+
+ +
+ + 2.1.1.2. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > package + + +
| | | | ------------ | -------- | @@ -87,7 +102,15 @@ **Description:** The package name to use for the generated code. -##### 2.1.1.3. Property `root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir` +
+
+ +
+ + 2.1.1.3. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir + + +
| | | | ------------ | -------- | @@ -96,6 +119,12 @@ **Description:** The directory containining the package.json to install the generated package in. +
+
+ +
+
+ #### 2.1.2. Property `root > generate > javascriptSdk > oneOf > item 1` | | | @@ -115,7 +144,7 @@ | ------------------------------------------------------- | ----------- | | [javascriptSdk](#generate_javascriptSdk_oneOf_i1_items) | - | -##### 2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk +##### 2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk | | | | ------------------------- | ------------------------------------------------------------------- | @@ -124,7 +153,19 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_javascriptSdk_oneOf_i0](#generate_javascriptSdk_oneOf_i0) | -### 2.2. Property `root > generate > dartSdk` +
+ +
+ +
+
+ +
+ + 2.2. [Optional] Property root > generate > dartSdk + + +
| | | | ------------------------- | ---------------- | @@ -134,11 +175,15 @@ **Description:** Configuration for a generated Dart SDK +
+ | One of(Option) | | ------------------------------------- | | [dartSdk](#generate_dartSdk_oneOf_i0) | | [item 1](#generate_dartSdk_oneOf_i1) | +
+ #### 2.2.1. Property `root > generate > dartSdk > oneOf > dartSdk` | | | @@ -148,13 +193,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/dartSdk | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | -| - [outputDir](#generate_dartSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | -| - [package](#generate_dartSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | -| - [](#generate_dartSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | +
+ + 2.2.1.1. [Optional] Property root > generate > dartSdk > oneOf > item 0 > outputDir -##### 2.2.1.1. Property `root > generate > dartSdk > oneOf > item 0 > outputDir` + +
| | | | ------------ | -------- | @@ -163,7 +207,15 @@ **Description:** Path to the directory where generated files should be written to. -##### 2.2.1.2. Property `root > generate > dartSdk > oneOf > item 0 > package` +
+
+ +
+ + 2.2.1.2. [Optional] Property root > generate > dartSdk > oneOf > item 0 > package + + +
| | | | ------------ | -------- | @@ -172,6 +224,12 @@ **Description:** The package name to use for the generated code. +
+
+ +
+
+ #### 2.2.2. Property `root > generate > dartSdk > oneOf > item 1` | | | @@ -191,7 +249,7 @@ | ------------------------------------------- | ----------- | | [dartSdk](#generate_dartSdk_oneOf_i1_items) | - | -##### 2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk +##### 2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk | | | | ------------------------- | ------------------------------------------------------- | @@ -200,7 +258,19 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_dartSdk_oneOf_i0](#generate_dartSdk_oneOf_i0) | -### 2.3. Property `root > generate > kotlinSdk` +
+ +
+ +
+
+ +
+ + 2.3. [Optional] Property root > generate > kotlinSdk + + +
| | | | ------------------------- | ---------------- | @@ -210,11 +280,15 @@ **Description:** Configuration for a generated Kotlin SDK +
+ | One of(Option) | | ----------------------------------------- | | [kotlinSdk](#generate_kotlinSdk_oneOf_i0) | | [item 1](#generate_kotlinSdk_oneOf_i1) | +
+ #### 2.3.1. Property `root > generate > kotlinSdk > oneOf > kotlinSdk` | | | @@ -224,13 +298,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/kotlinSdk | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | -| - [outputDir](#generate_kotlinSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | -| - [package](#generate_kotlinSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | -| - [](#generate_kotlinSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | +
+ + 2.3.1.1. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > outputDir -##### 2.3.1.1. Property `root > generate > kotlinSdk > oneOf > item 0 > outputDir` + +
| | | | ------------ | -------- | @@ -239,7 +312,15 @@ **Description:** Path to the directory where generated files should be written to. -##### 2.3.1.2. Property `root > generate > kotlinSdk > oneOf > item 0 > package` +
+
+ +
+ + 2.3.1.2. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > package + + +
| | | | ------------ | -------- | @@ -248,6 +329,12 @@ **Description:** The package name to use for the generated code. +
+
+ +
+
+ #### 2.3.2. Property `root > generate > kotlinSdk > oneOf > item 1` | | | @@ -267,7 +354,7 @@ | ----------------------------------------------- | ----------- | | [kotlinSdk](#generate_kotlinSdk_oneOf_i1_items) | - | -##### 2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk +##### 2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk | | | | ------------------------- | ----------------------------------------------------------- | @@ -276,7 +363,19 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_kotlinSdk_oneOf_i0](#generate_kotlinSdk_oneOf_i0) | -### 2.4. Property `root > generate > swiftSdk` +
+ +
+ +
+
+ +
+ + 2.4. [Optional] Property root > generate > swiftSdk + + +
| | | | ------------------------- | ---------------- | @@ -286,11 +385,15 @@ **Description:** Configuration for a generated Swift SDK +
+ | One of(Option) | | --------------------------------------- | | [swiftSdk](#generate_swiftSdk_oneOf_i0) | | [item 1](#generate_swiftSdk_oneOf_i1) | +
+ #### 2.4.1. Property `root > generate > swiftSdk > oneOf > swiftSdk` | | | @@ -300,12 +403,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/swiftSdk | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | -| - [outputDir](#generate_swiftSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | -| - [](#generate_swiftSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | +
+ + 2.4.1.1. [Optional] Property root > generate > swiftSdk > oneOf > item 0 > outputDir -##### 2.4.1.1. Property `root > generate > swiftSdk > oneOf > item 0 > outputDir` + +
| | | | ------------ | -------- | @@ -314,6 +417,12 @@ **Description:** Path to the directory where generated files should be written to. +
+
+ +
+
+ #### 2.4.2. Property `root > generate > swiftSdk > oneOf > item 1` | | | @@ -333,7 +442,7 @@ | --------------------------------------------- | ----------- | | [swiftSdk](#generate_swiftSdk_oneOf_i1_items) | - | -##### 2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk +##### 2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk | | | | ------------------------- | --------------------------------------------------------- | @@ -342,7 +451,19 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_swiftSdk_oneOf_i0](#generate_swiftSdk_oneOf_i0) | -### 2.5. Property `root > generate > llmTools` +
+ +
+ +
+
+ +
+ + 2.5. [Optional] Property root > generate > llmTools + + +
| | | | ------------------------- | ---------------- | @@ -350,11 +471,15 @@ | **Required** | No | | **Additional properties** | Any type allowed | +
+ | One of(Option) | | --------------------------------------- | | [llmTools](#generate_llmTools_oneOf_i0) | | [item 1](#generate_llmTools_oneOf_i1) | +
+ #### 2.5.1. Property `root > generate > llmTools > oneOf > llmTools` | | | @@ -364,12 +489,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/llmTools | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------ | -| - [outputFile](#generate_llmTools_oneOf_i0_outputFile ) | No | string | No | - | Path where the JSON LLM tool definitions file should be generated. | -| - [](#generate_llmTools_oneOf_i0_additionalProperties ) | No | object | No | - | - | +
+ + 2.5.1.1. [Optional] Property root > generate > llmTools > oneOf > item 0 > outputFile -##### 2.5.1.1. Property `root > generate > llmTools > oneOf > item 0 > outputFile` + +
| | | | ------------ | -------- | @@ -378,6 +503,12 @@ **Description:** Path where the JSON LLM tool definitions file should be generated. +
+
+ +
+
+ #### 2.5.2. Property `root > generate > llmTools > oneOf > item 1` | | | @@ -397,7 +528,7 @@ | --------------------------------------------- | ----------- | | [llmTools](#generate_llmTools_oneOf_i1_items) | - | -##### 2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools +##### 2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools | | | | ------------------------- | --------------------------------------------------------- | @@ -406,5 +537,15 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_llmTools_oneOf_i0](#generate_llmTools_oneOf_i0) | +
+ +
+ +
+
+ +
+
+ ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file diff --git a/schema/docs/dataconnect-yaml.md b/schema/docs/dataconnect-yaml.md index 1be32e8b4a9..f768005cf9e 100644 --- a/schema/docs/dataconnect-yaml.md +++ b/schema/docs/dataconnect-yaml.md @@ -8,15 +8,12 @@ **Description:** dataconnect.yaml is how you configure a Firebase Data Connect service. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------- | ------- | --------------- | ---------- | ----------------------- | ------------------------------------------------------------------------------------------- | -| - [specVersion](#specVersion ) | No | string | No | - | The Firebase Data Connect API version to target. If omitted, defaults to the latest version | -| - [serviceId](#serviceId ) | No | string | No | - | The ID of the Firebase Data Connect service. | -| - [location](#location ) | No | string | No | - | The region of the Firebase Data Connect service. | -| - [connectorDirs](#connectorDirs ) | No | array of string | No | - | A list of directories containing conector.yaml files describing a connector to deploy. | -| - [schema](#schema ) | No | object | No | In #/definitions/schema | - | +
+ + 1. [Optional] Property root > specVersion -## 1. Property `root > specVersion` + +
| | | | ------------ | -------- | @@ -25,7 +22,15 @@ **Description:** The Firebase Data Connect API version to target. If omitted, defaults to the latest version -## 2. Property `root > serviceId` +
+
+ +
+ + 2. [Optional] Property root > serviceId + + +
| | | | ------------ | -------- | @@ -34,7 +39,15 @@ **Description:** The ID of the Firebase Data Connect service. -## 3. Property `root > location` +
+
+ +
+ + 3. [Optional] Property root > location + + +
| | | | ------------ | -------- | @@ -43,7 +56,15 @@ **Description:** The region of the Firebase Data Connect service. -## 4. Property `root > connectorDirs` +
+
+ +
+ + 4. [Optional] Property root > connectorDirs + + +
| | | | ------------ | ----------------- | @@ -64,14 +85,22 @@ | ------------------------------------------- | ----------- | | [connectorDirs items](#connectorDirs_items) | - | -### 4.1. root > connectorDirs > connectorDirs items +### 4.1. root > connectorDirs > connectorDirs items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -## 5. Property `root > schema` +
+
+ +
+ + 5. [Optional] Property root > schema + + +
| | | | ------------------------- | -------------------- | @@ -80,12 +109,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/schema | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------- | ------- | ------ | ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------ | -| - [source](#schema_source ) | No | string | No | - | Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema. | -| - [datasource](#schema_datasource ) | No | object | No | In #/definitions/dataSource | - | +
+ + 5.1. [Optional] Property root > schema > source -### 5.1. Property `root > schema > source` + +
| | | | ------------ | -------- | @@ -94,7 +123,15 @@ **Description:** Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema. -### 5.2. Property `root > schema > datasource` +
+
+ +
+ + 5.2. [Optional] Property root > schema > datasource + + +
| | | | ------------------------- | ------------------------ | @@ -103,11 +140,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/dataSource | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------------- | ------- | ------ | ---------- | --------------------------- | ----------------- | -| - [postgresql](#schema_datasource_postgresql ) | No | object | No | In #/definitions/postgresql | - | +
+ + 5.2.1. [Optional] Property root > schema > datasource > postgresql -#### 5.2.1. Property `root > schema > datasource > postgresql` + +
| | | | ------------------------- | ------------------------ | @@ -116,12 +154,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/postgresql | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------ | -| - [database](#schema_datasource_postgresql_database ) | No | string | No | - | The name of the PostgreSQL database. | -| - [cloudSql](#schema_datasource_postgresql_cloudSql ) | No | object | No | - | - | +
+ + 5.2.1.1. [Optional] Property root > schema > datasource > postgresql > database -##### 5.2.1.1. Property `root > schema > datasource > postgresql > database` + +
| | | | ------------ | -------- | @@ -130,7 +168,15 @@ **Description:** The name of the PostgreSQL database. -##### 5.2.1.2. Property `root > schema > datasource > postgresql > cloudSql` +
+
+ +
+ + 5.2.1.2. [Optional] Property root > schema > datasource > postgresql > cloudSql + + +
| | | | ------------------------- | ----------- | @@ -138,12 +184,12 @@ | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------ | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------- | -| - [instanceId](#schema_datasource_postgresql_cloudSql_instanceId ) | No | string | No | - | The ID of the CloudSQL instance for this database | -| - [schemaValidation](#schema_datasource_postgresql_cloudSql_schemaValidation ) | No | enum (of string) | No | - | Schema validation mode for schema migrations | +
+ + 5.2.1.2.1. [Optional] Property root > schema > datasource > postgresql > cloudSql > instanceId -###### 5.2.1.2.1. Property `root > schema > datasource > postgresql > cloudSql > instanceId` + +
| | | | ------------ | -------- | @@ -152,7 +198,15 @@ **Description:** The ID of the CloudSQL instance for this database -###### 5.2.1.2.2. Property `root > schema > datasource > postgresql > cloudSql > schemaValidation` +
+
+ +
+ + 5.2.1.2.2. [Optional] Property root > schema > datasource > postgresql > cloudSql > schemaValidation + + +
| | | | ------------ | ------------------ | @@ -165,5 +219,20 @@ Must be one of: * "COMPATIBLE" * "STRICT" +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file diff --git a/schema/docs/extension-yaml.md b/schema/docs/extension-yaml.md index 8e920f66083..7fe7ee71ae0 100644 --- a/schema/docs/extension-yaml.md +++ b/schema/docs/extension-yaml.md @@ -8,30 +8,12 @@ **Description:** extension.yaml declares the resources and configurable parameters for a Firebase Extension. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------- | ------- | --------------- | ---------- | ----------------------- | -------------------------------------------------------------------------------------------------------------- | -| - [name](#name ) | No | string | No | - | ID of this extension (ie your-extension-name) | -| - [version](#version ) | No | string | No | - | Version of this extension. Follows https://semver.org/. | -| - [specVersion](#specVersion ) | No | string | No | - | Version of the extension.yaml spec that this file follows. Currently always 'v1beta' | -| - [license](#license ) | No | string | No | - | The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev | -| - [displayName](#displayName ) | No | string | No | - | Human readable name for this extension (ie 'Your Extension Name') | -| - [description](#description ) | No | string | No | - | A one to two sentence description of what this extension does | -| - [icon](#icon ) | No | string | No | - | The file name of this extension's icon | -| - [billingRequired](#billingRequired ) | No | boolean | No | - | Whether this extension requires a billing to be enabled on the project it is installed on | -| - [tags](#tags ) | No | array of string | No | - | A list of tags to help users find your extension in search | -| - [sourceUrl](#sourceUrl ) | No | string | No | - | The URL of the GitHub repo hosting this code | -| - [releaseNotesUrl](#releaseNotesUrl ) | No | string | No | - | A URL where users can view the full changelog or release notes for this extension | -| - [author](#author ) | No | object | No | In #/definitions/author | - | -| - [contributors](#contributors ) | No | array | No | - | - | -| - [apis](#apis ) | No | array | No | - | - | -| - [roles](#roles ) | No | array | No | - | - | -| - [externalServices](#externalServices ) | No | array | No | - | - | -| - [params](#params ) | No | array | No | - | - | -| - [resources](#resources ) | No | array | No | - | - | -| - [lifecycleEvents](#lifecycleEvents ) | No | array | No | - | - | -| - [events](#events ) | No | array | No | - | - | - -## 1. Property `root > name` +
+ + 1. [Optional] Property root > name + + +
| | | | ------------ | -------- | @@ -40,7 +22,15 @@ **Description:** ID of this extension (ie your-extension-name) -## 2. Property `root > version` +
+
+ +
+ + 2. [Optional] Property root > version + + +
| | | | ------------ | -------- | @@ -49,7 +39,15 @@ **Description:** Version of this extension. Follows https://semver.org/. -## 3. Property `root > specVersion` +
+
+ +
+ + 3. [Optional] Property root > specVersion + + +
| | | | ------------ | -------- | @@ -58,7 +56,15 @@ **Description:** Version of the extension.yaml spec that this file follows. Currently always 'v1beta' -## 4. Property `root > license` +
+
+ +
+ + 4. [Optional] Property root > license + + +
| | | | ------------ | -------- | @@ -67,7 +73,15 @@ **Description:** The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev -## 5. Property `root > displayName` +
+
+ +
+ + 5. [Optional] Property root > displayName + + +
| | | | ------------ | -------- | @@ -76,7 +90,15 @@ **Description:** Human readable name for this extension (ie 'Your Extension Name') -## 6. Property `root > description` +
+
+ +
+ + 6. [Optional] Property root > description + + +
| | | | ------------ | -------- | @@ -85,7 +107,15 @@ **Description:** A one to two sentence description of what this extension does -## 7. Property `root > icon` +
+
+ +
+ + 7. [Optional] Property root > icon + + +
| | | | ------------ | -------- | @@ -94,7 +124,15 @@ **Description:** The file name of this extension's icon -## 8. Property `root > billingRequired` +
+
+ +
+ + 8. [Optional] Property root > billingRequired + + +
| | | | ------------ | --------- | @@ -103,7 +141,15 @@ **Description:** Whether this extension requires a billing to be enabled on the project it is installed on -## 9. Property `root > tags` +
+
+ +
+ + 9. [Optional] Property root > tags + + +
| | | | ------------ | ----------------- | @@ -124,14 +170,22 @@ | ------------------------------- | ----------- | | [tags items](#tags_items) | - | -### 9.1. root > tags > tags items +### 9.1. root > tags > tags items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -## 10. Property `root > sourceUrl` +
+
+ +
+ + 10. [Optional] Property root > sourceUrl + + +
| | | | ------------ | -------- | @@ -140,7 +194,15 @@ **Description:** The URL of the GitHub repo hosting this code -## 11. Property `root > releaseNotesUrl` +
+
+ +
+ + 11. [Optional] Property root > releaseNotesUrl + + +
| | | | ------------ | -------- | @@ -149,7 +211,15 @@ **Description:** A URL where users can view the full changelog or release notes for this extension -## 12. Property `root > author` +
+
+ +
+ + 12. [Optional] Property root > author + + +
| | | | ------------------------- | -------------------- | @@ -158,13 +228,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/author | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ | -| - [authorName](#author_authorName ) | No | string | No | - | The author's name | -| - [email](#author_email ) | No | string | No | - | A contact email for the author | -| - [url](#author_url ) | No | string | No | - | URL of the author's website | +
+ + 12.1. [Optional] Property root > author > authorName -### 12.1. Property `root > author > authorName` + +
| | | | ------------ | -------- | @@ -173,7 +242,15 @@ **Description:** The author's name -### 12.2. Property `root > author > email` +
+
+ +
+ + 12.2. [Optional] Property root > author > email + + +
| | | | ------------ | -------- | @@ -182,7 +259,15 @@ **Description:** A contact email for the author -### 12.3. Property `root > author > url` +
+
+ +
+ + 12.3. [Optional] Property root > author > url + + +
| | | | ------------ | -------- | @@ -191,7 +276,18 @@ **Description:** URL of the author's website -## 13. Property `root > contributors` +
+
+ +
+
+ +
+ + 13. [Optional] Property root > contributors + + +
| | | | ------------ | ------- | @@ -210,7 +306,7 @@ | ------------------------------- | ----------- | | [author](#contributors_items) | - | -### 13.1. root > contributors > author +### 13.1. root > contributors > author | | | | ------------------------- | ----------------- | @@ -219,7 +315,15 @@ | **Additional properties** | Not allowed | | **Same definition as** | [author](#author) | -## 14. Property `root > apis` +
+
+ +
+ + 14. [Optional] Property root > apis + + +
| | | | ------------ | ------- | @@ -238,7 +342,7 @@ | ------------------------------- | ----------------------------------------------------------------------------- | | [api](#apis_items) | A Google API used by this extension. Will be enabled on extension deployment. | -### 14.1. root > apis > api +### 14.1. root > apis > api | | | | ------------------------- | ----------------- | @@ -249,12 +353,12 @@ **Description:** A Google API used by this extension. Will be enabled on extension deployment. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------- | -| + [apiName](#apis_items_apiName ) | No | string | No | - | Name of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library | -| + [reason](#apis_items_reason ) | No | string | No | - | Why this extension needs this API enabled | +
+ + 14.1.1. [Required] Property root > apis > apis items > apiName -#### 14.1.1. Property `root > apis > apis items > apiName` + +
| | | | ------------ | -------- | @@ -267,7 +371,15 @@ | --------------------------------- | ------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```[^\.]+\.googleapis\.com``` [Test](https://regex101.com/?regex=%5B%5E%5C.%5D%2B%5C.googleapis%5C.com) | -#### 14.1.2. Property `root > apis > apis items > reason` +
+
+ +
+ + 14.1.2. [Required] Property root > apis > apis items > reason + + +
| | | | ------------ | -------- | @@ -276,7 +388,18 @@ **Description:** Why this extension needs this API enabled -## 15. Property `root > roles` +
+
+ +
+
+ +
+ + 15. [Optional] Property root > roles + + +
| | | | ------------ | ------- | @@ -295,7 +418,7 @@ | ------------------------------- | --------------------------------------- | | [role](#roles_items) | An IAM role to grant to this extension. | -### 15.1. root > roles > role +### 15.1. root > roles > role | | | | ------------------------- | ------------------ | @@ -306,13 +429,12 @@ **Description:** An IAM role to grant to this extension. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| + [role](#roles_items_role ) | No | string | No | - | Name of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles | -| + [reason](#roles_items_reason ) | No | string | No | - | Why this extension needs this IAM role | -| - [resource](#roles_items_resource ) | No | string | No | - | What resource to grant this role on. If omitted, defaults to projects/${project_id} | +
+ + 15.1.1. [Required] Property root > roles > roles items > role -#### 15.1.1. Property `root > roles > roles items > role` + +
| | | | ------------ | -------- | @@ -325,7 +447,15 @@ | --------------------------------- | ------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```[a-zA-Z]+\.[a-zA-Z]+``` [Test](https://regex101.com/?regex=%5Ba-zA-Z%5D%2B%5C.%5Ba-zA-Z%5D%2B) | -#### 15.1.2. Property `root > roles > roles items > reason` +
+
+ +
+ + 15.1.2. [Required] Property root > roles > roles items > reason + + +
| | | | ------------ | -------- | @@ -334,7 +464,15 @@ **Description:** Why this extension needs this IAM role -#### 15.1.3. Property `root > roles > roles items > resource` +
+
+ +
+ + 15.1.3. [Optional] Property root > roles > roles items > resource + + +
| | | | ------------ | -------- | @@ -343,7 +481,18 @@ **Description:** What resource to grant this role on. If omitted, defaults to projects/${project_id} -## 16. Property `root > externalServices` +
+
+ +
+
+ +
+ + 16. [Optional] Property root > externalServices + + +
| | | | ------------ | ------- | @@ -362,7 +511,7 @@ | ------------------------------------------ | --------------------------------------- | | [externalService](#externalServices_items) | A non-Google API used by this extension | -### 16.1. root > externalServices > externalService +### 16.1. root > externalServices > externalService | | | | ------------------------- | ----------------------------- | @@ -373,12 +522,12 @@ **Description:** A non-Google API used by this extension -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [name](#externalServices_items_name ) | No | string | No | - | Name of the external service | -| - [pricingUri](#externalServices_items_pricingUri ) | No | string | No | - | URI to pricing information for the service | +
+ + 16.1.1. [Optional] Property root > externalServices > externalServices items > name -#### 16.1.1. Property `root > externalServices > externalServices items > name` + +
| | | | ------------ | -------- | @@ -387,7 +536,15 @@ **Description:** Name of the external service -#### 16.1.2. Property `root > externalServices > externalServices items > pricingUri` +
+
+ +
+ + 16.1.2. [Optional] Property root > externalServices > externalServices items > pricingUri + + +
| | | | ------------ | -------- | @@ -396,7 +553,18 @@ **Description:** URI to pricing information for the service -## 17. Property `root > params` +
+
+ +
+
+ +
+ + 17. [Optional] Property root > params + + +
| | | | ------------ | ------- | @@ -415,7 +583,7 @@ | ------------------------------- | -------------------------------------------------------------- | | [param](#params_items) | A parameter that users installing this extension can configure | -### 17.1. root > params > param +### 17.1. root > params > param | | | | ------------------------- | ------------------- | @@ -426,23 +594,12 @@ **Description:** A parameter that users installing this extension can configure -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| + [param](#params_items_param ) | No | string | No | - | The name of the param. This is how you reference the param in your code | -| - [label](#params_items_label ) | No | string | No | - | Short description for the parameter. Displayed to users when they're prompted for the parameter's value. | -| - [description](#params_items_description ) | No | string | No | - | Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value. | -| - [example](#params_items_example ) | No | string | No | - | Example value for the parameter. | -| - [validationRegex](#params_items_validationRegex ) | No | string | No | - | Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax. | -| - [validationErrorMessage](#params_items_validationErrorMessage ) | No | string | No | - | Error message to display if regex validation fails. | -| - [default](#params_items_default ) | No | string | No | - | Default value for the parameter if the user leaves the parameter's value blank. | -| - [required](#params_items_required ) | No | boolean | No | - | Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true. | -| - [immutable](#params_items_immutable ) | No | boolean | No | - | Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false. | -| - [advanced](#params_items_advanced ) | No | boolean | No | - | Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param. | -| - [type](#params_items_type ) | No | string | No | - | The parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details. | -| - [resourceType](#params_items_resourceType ) | No | string | No | - | The type of resource to prompt the user to select. Provides a special UI treatment for the param. | -| - [options](#params_items_options ) | No | array | No | - | Options for a select or multiSelect type param. | - -#### 17.1.1. Property `root > params > params items > param` +
+ + 17.1.1. [Required] Property root > params > params items > param + + +
| | | | ------------ | -------- | @@ -451,7 +608,15 @@ **Description:** The name of the param. This is how you reference the param in your code -#### 17.1.2. Property `root > params > params items > label` +
+
+ +
+ + 17.1.2. [Optional] Property root > params > params items > label + + +
| | | | ------------ | -------- | @@ -460,7 +625,15 @@ **Description:** Short description for the parameter. Displayed to users when they're prompted for the parameter's value. -#### 17.1.3. Property `root > params > params items > description` +
+
+ +
+ + 17.1.3. [Optional] Property root > params > params items > description + + +
| | | | ------------ | -------- | @@ -469,7 +642,15 @@ **Description:** Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value. -#### 17.1.4. Property `root > params > params items > example` +
+
+ +
+ + 17.1.4. [Optional] Property root > params > params items > example + + +
| | | | ------------ | -------- | @@ -478,7 +659,15 @@ **Description:** Example value for the parameter. -#### 17.1.5. Property `root > params > params items > validationRegex` +
+
+ +
+ + 17.1.5. [Optional] Property root > params > params items > validationRegex + + +
| | | | ------------ | -------- | @@ -487,7 +676,15 @@ **Description:** Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax. -#### 17.1.6. Property `root > params > params items > validationErrorMessage` +
+
+ +
+ + 17.1.6. [Optional] Property root > params > params items > validationErrorMessage + + +
| | | | ------------ | -------- | @@ -496,7 +693,15 @@ **Description:** Error message to display if regex validation fails. -#### 17.1.7. Property `root > params > params items > default` +
+
+ +
+ + 17.1.7. [Optional] Property root > params > params items > default + + +
| | | | ------------ | -------- | @@ -505,7 +710,15 @@ **Description:** Default value for the parameter if the user leaves the parameter's value blank. -#### 17.1.8. Property `root > params > params items > required` +
+
+ +
+ + 17.1.8. [Optional] Property root > params > params items > required + + +
| | | | ------------ | --------- | @@ -514,7 +727,15 @@ **Description:** Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true. -#### 17.1.9. Property `root > params > params items > immutable` +
+
+ +
+ + 17.1.9. [Optional] Property root > params > params items > immutable + + +
| | | | ------------ | --------- | @@ -523,7 +744,15 @@ **Description:** Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false. -#### 17.1.10. Property `root > params > params items > advanced` +
+
+ +
+ + 17.1.10. [Optional] Property root > params > params items > advanced + + +
| | | | ------------ | --------- | @@ -532,7 +761,15 @@ **Description:** Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param. -#### 17.1.11. Property `root > params > params items > type` +
+
+ +
+ + 17.1.11. [Optional] Property root > params > params items > type + + +
| | | | ------------ | -------- | @@ -545,7 +782,15 @@ | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```string\|select\|multiSelect\|secret\|selectResource``` [Test](https://regex101.com/?regex=string%7Cselect%7CmultiSelect%7Csecret%7CselectResource) | -#### 17.1.12. Property `root > params > params items > resourceType` +
+
+ +
+ + 17.1.12. [Optional] Property root > params > params items > resourceType + + +
| | | | ------------ | -------- | @@ -558,7 +803,15 @@ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```storage\.googleapis\.com\/Bucket\|firestore\.googleapis\.com\/Database\|firebasedatabase\.googleapis\.com\/DatabaseInstance``` [Test](https://regex101.com/?regex=storage%5C.googleapis%5C.com%5C%2FBucket%7Cfirestore%5C.googleapis%5C.com%5C%2FDatabase%7Cfirebasedatabase%5C.googleapis%5C.com%5C%2FDatabaseInstance) | -#### 17.1.13. Property `root > params > params items > options` +
+
+ +
+ + 17.1.13. [Optional] Property root > params > params items > options + + +
| | | | ------------ | ------- | @@ -579,7 +832,7 @@ | ------------------------------------------ | ----------- | | [paramOption](#params_items_options_items) | - | -##### 17.1.13.1. root > params > params items > options > paramOption +##### 17.1.13.1. root > params > params items > options > paramOption | | | | ------------------------- | ------------------------- | @@ -588,12 +841,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/paramOption | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- | -| + [value](#params_items_options_items_value ) | No | string | No | - | One of the values the user can choose. This is the value you get when you read the parameter value in code. | -| - [label](#params_items_options_items_label ) | No | string | No | - | Short description of the selectable option. If omitted, defaults to value. | +
+ + 17.1.13.1.1. [Required] Property root > params > params items > options > options items > value -###### 17.1.13.1.1. Property `root > params > params items > options > options items > value` + +
| | | | ------------ | -------- | @@ -602,7 +855,15 @@ **Description:** One of the values the user can choose. This is the value you get when you read the parameter value in code. -###### 17.1.13.1.2. Property `root > params > params items > options > options items > label` +
+
+ +
+ + 17.1.13.1.2. [Optional] Property root > params > params items > options > options items > label + + +
| | | | ------------ | -------- | @@ -611,7 +872,21 @@ **Description:** Short description of the selectable option. If omitted, defaults to value. -## 18. Property `root > resources` +
+
+ +
+
+ +
+
+ +
+ + 18. [Optional] Property root > resources + + +
| | | | ------------ | ------- | @@ -630,7 +905,7 @@ | ------------------------------- | ----------- | | [resource](#resources_items) | - | -### 18.1. root > resources > resource +### 18.1. root > resources > resource | | | | ------------------------- | ---------------------- | @@ -639,14 +914,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/resource | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| + [name](#resources_items_name ) | No | string | No | - | The name of this resource | -| + [type](#resources_items_type ) | No | string | No | - | What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options. | -| + [description](#resources_items_description ) | No | string | No | - | A brief description of what this resource does | -| + [properties](#resources_items_properties ) | No | object | No | - | The properties of this resource | +
+ + 18.1.1. [Required] Property root > resources > resources items > name -#### 18.1.1. Property `root > resources > resources items > name` + +
| | | | ------------ | -------- | @@ -655,7 +928,15 @@ **Description:** The name of this resource -#### 18.1.2. Property `root > resources > resources items > type` +
+
+ +
+ + 18.1.2. [Required] Property root > resources > resources items > type + + +
| | | | ------------ | -------- | @@ -664,7 +945,15 @@ **Description:** What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options. -#### 18.1.3. Property `root > resources > resources items > description` +
+
+ +
+ + 18.1.3. [Required] Property root > resources > resources items > description + + +
| | | | ------------ | -------- | @@ -673,7 +962,15 @@ **Description:** A brief description of what this resource does -#### 18.1.4. Property `root > resources > resources items > properties` +
+
+ +
+ + 18.1.4. [Required] Property root > resources > resources items > properties + + +
| | | | ------------------------- | ---------------- | @@ -683,23 +980,12 @@ **Description:** The properties of this resource -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| - [location](#resources_items_properties_location ) | No | string | No | - | The location for this resource | -| - [entryPoint](#resources_items_properties_entryPoint ) | No | string | No | - | The entry point for a function resource | -| - [sourceDirectory](#resources_items_properties_sourceDirectory ) | No | string | No | - | Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions | -| - [timeout](#resources_items_properties_timeout ) | No | string | No | - | A function resources's maximum execution time. | -| - [availableMemoryMb](#resources_items_properties_availableMemoryMb ) | No | string | No | - | Amount of memory in MB available for the function. | -| - [runtime](#resources_items_properties_runtime ) | No | string | No | - | Runtime environment for the function. Defaults to the most recent LTS version of node. | -| - [httpsTrigger](#resources_items_properties_httpsTrigger ) | No | object | No | - | A function triggered by HTTPS calls | -| - [eventTrigger](#resources_items_properties_eventTrigger ) | No | object | No | - | A function triggered by a background event | -| - [scheduleTrigger](#resources_items_properties_scheduleTrigger ) | No | object | No | - | A function triggered at a regular interval by a Cloud Scheduler job | -| - [taskQueueTrigger](#resources_items_properties_taskQueueTrigger ) | No | object | No | - | A function triggered by a Cloud Task | -| - [buildConfig](#resources_items_properties_buildConfig ) | No | object | No | - | Build configuration for a gen 2 Cloud Function | -| - [serviceConfig](#resources_items_properties_serviceConfig ) | No | object | No | - | Service configuration for a gen 2 Cloud Function | -| - [](#resources_items_properties_additionalProperties ) | No | object | No | - | - | - -##### 18.1.4.1. Property `root > resources > resources items > properties > location` +
+ + 18.1.4.1. [Optional] Property root > resources > resources items > properties > location + + +
| | | | ------------ | -------- | @@ -708,7 +994,15 @@ **Description:** The location for this resource -##### 18.1.4.2. Property `root > resources > resources items > properties > entryPoint` +
+
+ +
+ + 18.1.4.2. [Optional] Property root > resources > resources items > properties > entryPoint + + +
| | | | ------------ | -------- | @@ -717,7 +1011,15 @@ **Description:** The entry point for a function resource -##### 18.1.4.3. Property `root > resources > resources items > properties > sourceDirectory` +
+
+ +
+ + 18.1.4.3. [Optional] Property root > resources > resources items > properties > sourceDirectory + + +
| | | | ------------ | -------- | @@ -726,7 +1028,15 @@ **Description:** Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions -##### 18.1.4.4. Property `root > resources > resources items > properties > timeout` +
+
+ +
+ + 18.1.4.4. [Optional] Property root > resources > resources items > properties > timeout + + +
| | | | ------------ | -------- | @@ -739,7 +1049,15 @@ | --------------------------------- | ------------------------------------------------------- | | **Must match regular expression** | ```\d+s``` [Test](https://regex101.com/?regex=%5Cd%2Bs) | -##### 18.1.4.5. Property `root > resources > resources items > properties > availableMemoryMb` +
+
+ +
+ + 18.1.4.5. [Optional] Property root > resources > resources items > properties > availableMemoryMb + + +
| | | | ------------ | -------- | @@ -752,7 +1070,15 @@ | --------------------------------- | ----------------------------------------------------- | | **Must match regular expression** | ```\d+``` [Test](https://regex101.com/?regex=%5Cd%2B) | -##### 18.1.4.6. Property `root > resources > resources items > properties > runtime` +
+
+ +
+ + 18.1.4.6. [Optional] Property root > resources > resources items > properties > runtime + + +
| | | | ------------ | -------- | @@ -761,7 +1087,15 @@ **Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. -##### 18.1.4.7. Property `root > resources > resources items > properties > httpsTrigger` +
+
+ +
+ + 18.1.4.7. [Optional] Property root > resources > resources items > properties > httpsTrigger + + +
| | | | ------------------------- | ---------------- | @@ -771,7 +1105,15 @@ **Description:** A function triggered by HTTPS calls -##### 18.1.4.8. Property `root > resources > resources items > properties > eventTrigger` +
+
+ +
+ + 18.1.4.8. [Optional] Property root > resources > resources items > properties > eventTrigger + + +
| | | | ------------------------- | ---------------- | @@ -781,15 +1123,12 @@ **Description:** A function triggered by a background event -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| + [eventType](#resources_items_properties_eventTrigger_eventType ) | No | string | No | - | The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list. | -| - [resource](#resources_items_properties_eventTrigger_resource ) | No | string | No | - | The name or pattern of the resource to trigger on | -| - [eventFilters](#resources_items_properties_eventTrigger_eventFilters ) | No | array | No | - | Filters that further limit the events to listen to. | -| - [channel](#resources_items_properties_eventTrigger_channel ) | No | string | No | - | The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel. | -| - [triggerRegion](#resources_items_properties_eventTrigger_triggerRegion ) | No | string | No | - | The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function. | +
+ + 18.1.4.8.1. [Required] Property root > resources > resources items > properties > eventTrigger > eventType -###### 18.1.4.8.1. Property `root > resources > resources items > properties > eventTrigger > eventType` + +
| | | | ------------ | -------- | @@ -798,7 +1137,15 @@ **Description:** The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list. -###### 18.1.4.8.2. Property `root > resources > resources items > properties > eventTrigger > resource` +
+
+ +
+ + 18.1.4.8.2. [Optional] Property root > resources > resources items > properties > eventTrigger > resource + + +
| | | | ------------ | -------- | @@ -807,7 +1154,15 @@ **Description:** The name or pattern of the resource to trigger on -###### 18.1.4.8.3. Property `root > resources > resources items > properties > eventTrigger > eventFilters` +
+
+ +
+ + 18.1.4.8.3. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters + + +
| | | | ------------ | ------- | @@ -828,7 +1183,7 @@ | -------------------------------------------------------------------------- | ----------- | | [eventFilter](#resources_items_properties_eventTrigger_eventFilters_items) | - | -###### 18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter +###### 18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter | | | | ------------------------- | ------------------------- | @@ -837,12 +1192,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/eventFilter | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------- | -| - [attribute](#resources_items_properties_eventTrigger_eventFilters_items_attribute ) | No | string | No | - | The event attribute to filter on | -| - [value](#resources_items_properties_eventTrigger_eventFilters_items_value ) | No | string | No | - | The value to filter for | +
+ + 18.1.4.8.3.1.1. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute -###### 18.1.4.8.3.1.1. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute` + +
| | | | ------------ | -------- | @@ -851,7 +1206,15 @@ **Description:** The event attribute to filter on -###### 18.1.4.8.3.1.2. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value` +
+
+ +
+ + 18.1.4.8.3.1.2. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value + + +
| | | | ------------ | -------- | @@ -860,7 +1223,18 @@ **Description:** The value to filter for -###### 18.1.4.8.4. Property `root > resources > resources items > properties > eventTrigger > channel` +
+
+ +
+
+ +
+ + 18.1.4.8.4. [Optional] Property root > resources > resources items > properties > eventTrigger > channel + + +
| | | | ------------ | -------- | @@ -869,7 +1243,15 @@ **Description:** The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel. -###### 18.1.4.8.5. Property `root > resources > resources items > properties > eventTrigger > triggerRegion` +
+
+ +
+ + 18.1.4.8.5. [Optional] Property root > resources > resources items > properties > eventTrigger > triggerRegion + + +
| | | | ------------ | -------- | @@ -878,7 +1260,18 @@ **Description:** The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function. -##### 18.1.4.9. Property `root > resources > resources items > properties > scheduleTrigger` +
+
+ +
+
+ +
+ + 18.1.4.9. [Optional] Property root > resources > resources items > properties > scheduleTrigger + + +
| | | | ------------------------- | ---------------- | @@ -888,12 +1281,12 @@ **Description:** A function triggered at a regular interval by a Cloud Scheduler job -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| + [schedule](#resources_items_properties_scheduleTrigger_schedule ) | No | string | No | - | The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax. | -| - [timeZone](#resources_items_properties_scheduleTrigger_timeZone ) | No | string | No | - | The time zone in which the schedule will run. Defaults to UTC. | +
+ + 18.1.4.9.1. [Required] Property root > resources > resources items > properties > scheduleTrigger > schedule -###### 18.1.4.9.1. Property `root > resources > resources items > properties > scheduleTrigger > schedule` + +
| | | | ------------ | -------- | @@ -902,7 +1295,15 @@ **Description:** The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax. -###### 18.1.4.9.2. Property `root > resources > resources items > properties > scheduleTrigger > timeZone` +
+
+ +
+ + 18.1.4.9.2. [Optional] Property root > resources > resources items > properties > scheduleTrigger > timeZone + + +
| | | | ------------ | -------- | @@ -911,7 +1312,18 @@ **Description:** The time zone in which the schedule will run. Defaults to UTC. -##### 18.1.4.10. Property `root > resources > resources items > properties > taskQueueTrigger` +
+
+ +
+
+ +
+ + 18.1.4.10. [Optional] Property root > resources > resources items > properties > taskQueueTrigger + + +
| | | | ------------------------- | ---------------- | @@ -921,7 +1333,15 @@ **Description:** A function triggered by a Cloud Task -##### 18.1.4.11. Property `root > resources > resources items > properties > buildConfig` +
+
+ +
+ + 18.1.4.11. [Optional] Property root > resources > resources items > properties > buildConfig + + +
| | | | ------------------------- | ---------------- | @@ -931,12 +1351,12 @@ **Description:** Build configuration for a gen 2 Cloud Function -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------- | -| - [runtime](#resources_items_properties_buildConfig_runtime ) | No | string | No | - | Runtime environment for the function. Defaults to the most recent LTS version of node. | -| - [entryPoint](#resources_items_properties_buildConfig_entryPoint ) | No | string | No | - | The entry point for a function resource | +
+ + 18.1.4.11.1. [Optional] Property root > resources > resources items > properties > buildConfig > runtime -###### 18.1.4.11.1. Property `root > resources > resources items > properties > buildConfig > runtime` + +
| | | | ------------ | -------- | @@ -945,7 +1365,15 @@ **Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. -###### 18.1.4.11.2. Property `root > resources > resources items > properties > buildConfig > entryPoint` +
+
+ +
+ + 18.1.4.11.2. [Optional] Property root > resources > resources items > properties > buildConfig > entryPoint + + +
| | | | ------------ | -------- | @@ -954,7 +1382,18 @@ **Description:** The entry point for a function resource -##### 18.1.4.12. Property `root > resources > resources items > properties > serviceConfig` +
+
+ +
+
+ +
+ + 18.1.4.12. [Optional] Property root > resources > resources items > properties > serviceConfig + + +
| | | | ------------------------- | ---------------- | @@ -964,12 +1403,12 @@ **Description:** Service configuration for a gen 2 Cloud Function -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [timeoutSeconds](#resources_items_properties_serviceConfig_timeoutSeconds ) | No | string | No | - | The function's maximum execution time. Default: 60, max value: 540. | -| - [availableMemory](#resources_items_properties_serviceConfig_availableMemory ) | No | string | No | - | The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes. | +
+ + 18.1.4.12.1. [Optional] Property root > resources > resources items > properties > serviceConfig > timeoutSeconds -###### 18.1.4.12.1. Property `root > resources > resources items > properties > serviceConfig > timeoutSeconds` + +
| | | | ------------ | -------- | @@ -978,7 +1417,15 @@ **Description:** The function's maximum execution time. Default: 60, max value: 540. -###### 18.1.4.12.2. Property `root > resources > resources items > properties > serviceConfig > availableMemory` +
+
+ +
+ + 18.1.4.12.2. [Optional] Property root > resources > resources items > properties > serviceConfig > availableMemory + + +
| | | | ------------ | -------- | @@ -987,7 +1434,24 @@ **Description:** The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes. -## 19. Property `root > lifecycleEvents` +
+
+ +
+
+ +
+
+ +
+
+ +
+ + 19. [Optional] Property root > lifecycleEvents + + +
| | | | ------------ | ------- | @@ -1006,7 +1470,7 @@ | ---------------------------------------- | ----------- | | [lifecycleEvent](#lifecycleEvents_items) | - | -### 19.1. root > lifecycleEvents > lifecycleEvent +### 19.1. root > lifecycleEvents > lifecycleEvent | | | | ------------------------- | ---------------------------- | @@ -1015,13 +1479,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/lifecycleEvent | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------ | ----------------- | -| - [onInstall](#lifecycleEvents_items_onInstall ) | No | object | No | In #/definitions/lifecycleEventSpec | - | -| - [onUpdate](#lifecycleEvents_items_onUpdate ) | No | object | No | Same as [onInstall](#lifecycleEvents_items_onInstall ) | - | -| - [onConfigure](#lifecycleEvents_items_onConfigure ) | No | object | No | Same as [onInstall](#lifecycleEvents_items_onInstall ) | - | +
+ + 19.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall -#### 19.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall` + +
| | | | ------------------------- | -------------------------------- | @@ -1030,12 +1493,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/lifecycleEventSpec | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| - [function](#lifecycleEvents_items_onInstall_function ) | No | string | No | - | Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section. | -| - [processingMessage](#lifecycleEvents_items_onInstall_processingMessage ) | No | string | No | - | Message to display in the Firebase console while the task is in progress. | +
+ + 19.1.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > function -##### 19.1.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > function` + +
| | | | ------------ | -------- | @@ -1044,7 +1507,15 @@ **Description:** Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section. -##### 19.1.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage` +
+
+ +
+ + 19.1.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage + + +
| | | | ------------ | -------- | @@ -1053,7 +1524,18 @@ **Description:** Message to display in the Firebase console while the task is in progress. -#### 19.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onUpdate` +
+
+ +
+
+ +
+ + 19.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onUpdate + + +
| | | | ------------------------- | --------------------------------------------- | @@ -1062,7 +1544,15 @@ | **Additional properties** | Not allowed | | **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | -#### 19.1.3. Property `root > lifecycleEvents > lifecycleEvents items > onConfigure` +
+
+ +
+ + 19.1.3. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onConfigure + + +
| | | | ------------------------- | --------------------------------------------- | @@ -1071,7 +1561,18 @@ | **Additional properties** | Not allowed | | **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | -## 20. Property `root > events` +
+
+ +
+
+ +
+ + 20. [Optional] Property root > events + + +
| | | | ------------ | ------- | @@ -1090,7 +1591,7 @@ | ------------------------------- | ----------- | | [event](#events_items) | - | -### 20.1. root > events > event +### 20.1. root > events > event | | | | ------------------------- | ------------------- | @@ -1099,12 +1600,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/event | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [type](#events_items_type ) | No | string | No | - | The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish. | -| - [description](#events_items_description ) | No | string | No | - | A description of the event | +
+ + 20.1.1. [Optional] Property root > events > events items > type -#### 20.1.1. Property `root > events > events items > type` + +
| | | | ------------ | -------- | @@ -1113,7 +1614,15 @@ **Description:** The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish. -#### 20.1.2. Property `root > events > events items > description` +
+
+ +
+ + 20.1.2. [Optional] Property root > events > events items > description + + +
| | | | ------------ | -------- | @@ -1122,5 +1631,11 @@ **Description:** A description of the event +
+
+ +
+
+ ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md index 759ecdf4c43..54a8cc46692 100644 --- a/schema/docs/firebase-config.md +++ b/schema/docs/firebase-config.md @@ -9,21 +9,12 @@ **Description:** Information about the resources in your Firebase project. This used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start` -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------- | ------- | ----------- | ---------- | ----------------------------------- | ----------------------------------------------------------------------------- | -| - [$schema](#schema ) | No | string | No | - | Unused. Included in schema so that the schema can be applied to single files. | -| - [apphosting](#apphosting ) | No | Combination | No | - | The App Hosting backend(s) that should be deployed or emulated. | -| - [database](#database ) | No | Combination | No | - | The Realtime Database rules that should be deployed or emulated. | -| - [dataconnect](#dataconnect ) | No | Combination | No | - | The Data Connect service(s) that should be deployed or emulated. | -| - [emulators](#emulators ) | No | object | No | - | Hosts, ports, and configuration options for the Firebase Emulator suite. | -| - [extensions](#extensions ) | No | object | No | In #/definitions/ExtensionsConfig | The Firebase Extension(s) that should be deployed or emulated. | -| - [firestore](#firestore ) | No | Combination | No | - | The Firestore rules and indexes that should be deployed or emulated. | -| - [functions](#functions ) | No | Combination | No | - | The Cloud Functions for Firebase that should be deployed or emulated. | -| - [hosting](#hosting ) | No | Combination | No | - | The Firebase Hosting site(s) that should be deployed or emulated. | -| - [remoteconfig](#remoteconfig ) | No | object | No | In #/definitions/RemoteConfigConfig | The Remote Config template(s) used by this project. | -| - [storage](#storage ) | No | Combination | No | - | The Firebase Storage rules that should be deployed or emulated. | +
+ + 1. [Optional] Property root > $schema -## 1. Property `root > $schema` + +
| | | | ------------ | -------- | @@ -33,7 +24,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Unused. Included in schema so that the schema can be applied to single files. -## 2. Property `root > apphosting` +
+
+ +
+ + 2. [Optional] Property root > apphosting + + +
| | | | ------------------------- | ---------------- | @@ -43,11 +42,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The App Hosting backend(s) that should be deployed or emulated. +
+ | Any of(Option) | | ------------------------------ | | [item 0](#apphosting_anyOf_i0) | | [item 1](#apphosting_anyOf_i1) | +
+ ### 2.1. Property `root > apphosting > anyOf > item 0` | | | @@ -58,14 +61,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single App Hosting deployment configs -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------------------- | -| - [alwaysDeployFromSource](#apphosting_anyOf_i0_alwaysDeployFromSource ) | No | boolean | No | - | If true, this backend will only be deployed from local source, not from source control. | -| + [backendId](#apphosting_anyOf_i0_backendId ) | No | string | No | - | - | -| + [ignore](#apphosting_anyOf_i0_ignore ) | No | array of string | No | - | A list of file paths to exclude from the archive that is uploaded for this backend. | -| + [rootDir](#apphosting_anyOf_i0_rootDir ) | No | string | No | - | - | +
+ + 2.1.1. [Optional] Property root > apphosting > anyOf > item 0 > alwaysDeployFromSource -#### 2.1.1. Property `root > apphosting > anyOf > item 0 > alwaysDeployFromSource` + +
| | | | ------------ | --------- | @@ -74,14 +75,30 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** If true, this backend will only be deployed from local source, not from source control. -#### 2.1.2. Property `root > apphosting > anyOf > item 0 > backendId` +
+
+ +
+ + 2.1.2. [Required] Property root > apphosting > anyOf > item 0 > backendId + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -#### 2.1.3. Property `root > apphosting > anyOf > item 0 > ignore` +
+
+ +
+ + 2.1.3. [Required] Property root > apphosting > anyOf > item 0 > ignore + + +
| | | | ------------ | ----------------- | @@ -102,20 +119,34 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------- | ----------- | | [ignore items](#apphosting_anyOf_i0_ignore_items) | - | -##### 2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items +##### 2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -#### 2.1.4. Property `root > apphosting > anyOf > item 0 > rootDir` +
+
+ +
+ + 2.1.4. [Required] Property root > apphosting > anyOf > item 0 > rootDir + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | +
+
+ +
+
+ ### 2.2. Property `root > apphosting > anyOf > item 1` | | | @@ -137,7 +168,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------ | --------------------------------------- | | [item 1 items](#apphosting_anyOf_i1_items) | A single App Hosting deployment configs | -#### 2.2.1. root > apphosting > anyOf > item 1 > item 1 items +#### 2.2.1. root > apphosting > anyOf > item 1 > item 1 items | | | | ------------------------- | ----------- | @@ -147,14 +178,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single App Hosting deployment configs -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------------------- | -| - [alwaysDeployFromSource](#apphosting_anyOf_i1_items_alwaysDeployFromSource ) | No | boolean | No | - | If true, this backend will only be deployed from local source, not from source control. | -| + [backendId](#apphosting_anyOf_i1_items_backendId ) | No | string | No | - | - | -| + [ignore](#apphosting_anyOf_i1_items_ignore ) | No | array of string | No | - | A list of file paths to exclude from the archive that is uploaded for this backend. | -| + [rootDir](#apphosting_anyOf_i1_items_rootDir ) | No | string | No | - | - | +
+ + 2.2.1.1. [Optional] Property root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource -##### 2.2.1.1. Property `root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource` + +
| | | | ------------ | --------- | @@ -163,14 +192,30 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** If true, this backend will only be deployed from local source, not from source control. -##### 2.2.1.2. Property `root > apphosting > anyOf > item 1 > item 1 items > backendId` +
+
+ +
+ + 2.2.1.2. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > backendId + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -##### 2.2.1.3. Property `root > apphosting > anyOf > item 1 > item 1 items > ignore` +
+
+ +
+ + 2.2.1.3. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > ignore + + +
| | | | ------------ | ----------------- | @@ -191,21 +236,44 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------------- | ----------- | | [ignore items](#apphosting_anyOf_i1_items_ignore_items) | - | -###### 2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items +###### 2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -##### 2.2.1.4. Property `root > apphosting > anyOf > item 1 > item 1 items > rootDir` +
+
+ +
+ + 2.2.1.4. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > rootDir + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -## 3. Property `root > database` +
+
+ +
+ +
+ +
+
+ +
+ + 3. [Optional] Property root > database + + +
| | | | ------------------------- | ---------------- | @@ -215,11 +283,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The Realtime Database rules that should be deployed or emulated. +
+ | Any of(Option) | | ------------------------------------ | | [DatabaseSingle](#database_anyOf_i0) | | [item 1](#database_anyOf_i1) | +
+ ### 3.1. Property `root > database > anyOf > DatabaseSingle` | | | @@ -231,13 +303,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Deployment options for a single Realtime Database instance. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | -| - [postdeploy](#database_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#database_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| + [rules](#database_anyOf_i0_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | +
+ + 3.1.1. [Optional] Property root > database > anyOf > item 0 > postdeploy -#### 3.1.1. Property `root > database > anyOf > item 0 > postdeploy` + +
| | | | ------------------------- | ---------------- | @@ -247,11 +318,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ------------------------------------------------ | | [item 0](#database_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i0_postdeploy_anyOf_i1) | +
+ ##### 3.1.1.1. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -271,13 +346,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------------------ | ----------- | | [item 0 items](#database_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 3.1.1.2. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -285,7 +363,19 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -#### 3.1.2. Property `root > database > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 3.1.2. [Optional] Property root > database > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -295,11 +385,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ----------------------------------------------- | | [item 0](#database_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i0_predeploy_anyOf_i1) | +
+ ##### 3.1.2.1. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -319,13 +413,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | ----------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 3.1.2.2. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -333,7 +430,19 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -#### 3.1.3. Property `root > database > anyOf > item 0 > rules` +
+ +
+ +
+
+ +
+ + 3.1.3. [Required] Property root > database > anyOf > item 0 > rules + + +
| | | | ------------ | -------- | @@ -342,6 +451,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. +
+
+ +
+
+ ### 3.2. Property `root > database > anyOf > item 1` | | | @@ -363,7 +478,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ---------------------------------------- | ----------- | | [item 1 items](#database_anyOf_i1_items) | - | -#### 3.2.1. root > database > anyOf > item 1 > item 1 items +#### 3.2.1. root > database > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -371,11 +486,15 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Any type allowed | +
+ | Any of(Option) | | ------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1) | +
+ ##### 3.2.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -384,15 +503,12 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | -| + [instance](#database_anyOf_i1_items_anyOf_i0_instance ) | No | string | No | - | The instance that this rules files is for. | -| - [postdeploy](#database_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#database_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| + [rules](#database_anyOf_i1_items_anyOf_i0_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | -| - [target](#database_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | - | +
+ + 3.2.1.1.1. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance -###### 3.2.1.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance` + +
| | | | ------------ | -------- | @@ -401,7 +517,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The instance that this rules files is for. -###### 3.2.1.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` +
+
+ +
+ + 3.2.1.1.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -411,11 +535,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | +
+ ###### 3.2.1.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -435,13 +563,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 3.2.1.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -449,7 +580,19 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -###### 3.2.1.1.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 3.2.1.1.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -459,11 +602,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | +
+ ###### 3.2.1.1.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -483,13 +630,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 3.2.1.1.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -497,7 +647,19 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -###### 3.2.1.1.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules` +
+ +
+ +
+
+ +
+ + 3.2.1.1.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules + + +
| | | | ------------ | -------- | @@ -506,13 +668,27 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -###### 3.2.1.1.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target` +
+
+ +
+ + 3.2.1.1.5. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ +
+
+ ##### 3.2.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -521,15 +697,12 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | -| - [instance](#database_anyOf_i1_items_anyOf_i1_instance ) | No | string | No | - | The instance that this rules files is for. | -| - [postdeploy](#database_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#database_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| + [rules](#database_anyOf_i1_items_anyOf_i1_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | -| + [target](#database_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | - | +
+ + 3.2.1.2.1. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance -###### 3.2.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance` + +
| | | | ------------ | -------- | @@ -538,7 +711,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The instance that this rules files is for. -###### 3.2.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` +
+
+ +
+ + 3.2.1.2.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -548,11 +729,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | +
+ ###### 3.2.1.2.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -572,13 +757,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 3.2.1.2.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -586,7 +774,19 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -###### 3.2.1.2.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` +
+ +
+ +
+
+ +
+ + 3.2.1.2.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -596,11 +796,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | +
+ ###### 3.2.1.2.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -620,13 +824,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 3.2.1.2.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -634,7 +841,19 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -###### 3.2.1.2.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules` +
+ +
+ +
+
+ +
+ + 3.2.1.2.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules + + +
| | | | ------------ | -------- | @@ -643,14 +862,41 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -###### 3.2.1.2.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target` +
+
+ +
+ + 3.2.1.2.5. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -## 4. Property `root > dataconnect` +
+
+ +
+ +
+ +
+ +
+ +
+
+ +
+ + 4. [Optional] Property root > dataconnect + + +
| | | | ------------------------- | ---------------- | @@ -660,11 +906,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The Data Connect service(s) that should be deployed or emulated. +
+ | Any of(Option) | | ------------------------------------------ | | [DataConnectSingle](#dataconnect_anyOf_i0) | | [item 1](#dataconnect_anyOf_i1) | +
+ ### 4.1. Property `root > dataconnect > anyOf > DataConnectSingle` | | | @@ -676,13 +926,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single Data Connect deployment configs -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | -| - [postdeploy](#dataconnect_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#dataconnect_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| + [source](#dataconnect_anyOf_i0_source ) | No | string | No | - | - | +
+ + 4.1.1. [Optional] Property root > dataconnect > anyOf > item 0 > postdeploy -#### 4.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy` + +
| | | | ------------------------- | ---------------- | @@ -692,11 +941,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | --------------------------------------------------- | | [item 0](#dataconnect_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#dataconnect_anyOf_i0_postdeploy_anyOf_i1) | +
+ ##### 4.1.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -716,13 +969,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------- | ----------- | | [item 0 items](#dataconnect_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 4.1.1.2. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -730,7 +986,19 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -#### 4.1.2. Property `root > dataconnect > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 4.1.2. [Optional] Property root > dataconnect > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -740,11 +1008,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | -------------------------------------------------- | | [item 0](#dataconnect_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#dataconnect_anyOf_i0_predeploy_anyOf_i1) | +
+ ##### 4.1.2.1. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -764,13 +1036,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------- | ----------- | | [item 0 items](#dataconnect_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 4.1.2.2. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -778,13 +1053,31 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -#### 4.1.3. Property `root > dataconnect > anyOf > item 0 > source` +
+ +
+ +
+
+ +
+ + 4.1.3. [Required] Property root > dataconnect > anyOf > item 0 > source + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | +
+
+ +
+
+ ### 4.2. Property `root > dataconnect > anyOf > item 1` | | | @@ -806,7 +1099,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------ | ---------------------------------------- | | [DataConnectSingle](#dataconnect_anyOf_i1_items) | A single Data Connect deployment configs | -#### 4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle +#### 4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle | | | | ------------------------- | --------------------------------------------- | @@ -817,7 +1110,19 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single Data Connect deployment configs -## 5. Property `root > emulators` +
+ +
+ +
+
+ +
+ + 5. [Optional] Property root > emulators + + +
| | | | ------------------------- | ----------- | @@ -827,25 +1132,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Hosts, ports, and configuration options for the Firebase Emulator suite. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------------------- | -| - [apphosting](#emulators_apphosting ) | No | object | No | - | Config for the App Hosting emulator | -| - [auth](#emulators_auth ) | No | object | No | - | Config for the Auth emulator | -| - [database](#emulators_database ) | No | object | No | - | Config for the Realtime Database emulator | -| - [dataconnect](#emulators_dataconnect ) | No | object | No | - | Config for the Data Connect emulator. | -| - [eventarc](#emulators_eventarc ) | No | object | No | - | Config for the EventArc emulator. | -| - [extensions](#emulators_extensions ) | No | object | No | - | Placeholder - the Extensions emulator has no configuration options. | -| - [firestore](#emulators_firestore ) | No | object | No | - | Config for the Firestore emulator | -| - [hosting](#emulators_hosting ) | No | object | No | - | Config for the Firebase Hosting emulator | -| - [hub](#emulators_hub ) | No | object | No | - | Config for the emulator suite hub. | -| - [logging](#emulators_logging ) | No | object | No | - | Config for the logging emulator. | -| - [pubsub](#emulators_pubsub ) | No | object | No | - | Config for the Pub/Sub emulator | -| - [singleProjectMode](#emulators_singleProjectMode ) | No | boolean | No | - | If true, the Emulator Suite will only allow a single project to be used at a time. | -| - [storage](#emulators_storage ) | No | object | No | - | Config for the Firebase Storage emulator | -| - [tasks](#emulators_tasks ) | No | object | No | - | Config for the Cloud Tasks emulator. | -| - [ui](#emulators_ui ) | No | object | No | - | Config for the Emulator UI. | - -### 5.1. Property `root > emulators > apphosting` +
+ + 5.1. [Optional] Property root > emulators > apphosting + + +
| | | | ------------------------- | ----------- | @@ -855,15 +1147,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the App Hosting emulator -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------- | -| - [host](#emulators_apphosting_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_apphosting_port ) | No | number | No | - | The port that this emulator will serve on. | -| - [rootDirectory](#emulators_apphosting_rootDirectory ) | No | string | No | - | The root directory of your app. The start command will ran from this directory. | -| - [startCommand](#emulators_apphosting_startCommand ) | No | string | No | - | The command that will be run to start your app when emulating your App Hosting backend | -| - [startCommandOverride](#emulators_apphosting_startCommandOverride ) | No | string | No | - | - | +
+ + 5.1.1. [Optional] Property root > emulators > apphosting > host -#### 5.1.1. Property `root > emulators > apphosting > host` + +
| | | | ------------ | -------- | @@ -872,7 +1161,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -#### 5.1.2. Property `root > emulators > apphosting > port` +
+
+ +
+ + 5.1.2. [Optional] Property root > emulators > apphosting > port + + +
| | | | ------------ | -------- | @@ -881,7 +1178,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -#### 5.1.3. Property `root > emulators > apphosting > rootDirectory` +
+
+ +
+ + 5.1.3. [Optional] Property root > emulators > apphosting > rootDirectory + + +
| | | | ------------ | -------- | @@ -890,7 +1195,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The root directory of your app. The start command will ran from this directory. -#### 5.1.4. Property `root > emulators > apphosting > startCommand` +
+
+ +
+ + 5.1.4. [Optional] Property root > emulators > apphosting > startCommand + + +
| | | | ------------ | -------- | @@ -899,14 +1212,33 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The command that will be run to start your app when emulating your App Hosting backend -#### 5.1.5. Property `root > emulators > apphosting > startCommandOverride` +
+
+ +
+ + 5.1.5. [Optional] Property root > emulators > apphosting > startCommandOverride + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -### 5.2. Property `root > emulators > auth` +
+
+ +
+
+ +
+ + 5.2. [Optional] Property root > emulators > auth + + +
| | | | ------------------------- | ----------- | @@ -916,12 +1248,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Auth emulator -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_auth_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_auth_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.2.1. [Optional] Property root > emulators > auth > host -#### 5.2.1. Property `root > emulators > auth > host` + +
| | | | ------------ | -------- | @@ -930,7 +1262,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -#### 5.2.2. Property `root > emulators > auth > port` +
+
+ +
+ + 5.2.2. [Optional] Property root > emulators > auth > port + + +
| | | | ------------ | -------- | @@ -939,7 +1279,18 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -### 5.3. Property `root > emulators > database` +
+
+ +
+
+ +
+ + 5.3. [Optional] Property root > emulators > database + + +
| | | | ------------------------- | ----------- | @@ -949,12 +1300,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Realtime Database emulator -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_database_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_database_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.3.1. [Optional] Property root > emulators > database > host -#### 5.3.1. Property `root > emulators > database > host` + +
| | | | ------------ | -------- | @@ -963,7 +1314,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -#### 5.3.2. Property `root > emulators > database > port` +
+
+ +
+ + 5.3.2. [Optional] Property root > emulators > database > port + + +
| | | | ------------ | -------- | @@ -972,7 +1331,18 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -### 5.4. Property `root > emulators > dataconnect` +
+
+ +
+
+ +
+ + 5.4. [Optional] Property root > emulators > dataconnect + + +
| | | | ------------------------- | ----------- | @@ -982,15 +1352,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Data Connect emulator. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [dataDir](#emulators_dataconnect_dataDir ) | No | string | No | - | The directory to persist emulator data to. If set, data will be saved between runs automatically.
If the --import flag is used, the current data will be overwritten by the imported data. | -| - [host](#emulators_dataconnect_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_dataconnect_port ) | No | number | No | - | The port that this emulator will serve on. | -| - [postgresHost](#emulators_dataconnect_postgresHost ) | No | string | No | - | Host for the Postgres database that backs the Data Connect emulator. | -| - [postgresPort](#emulators_dataconnect_postgresPort ) | No | number | No | - | Port for the Postgres database that backs the Data Connect emulator. | +
+ + 5.4.1. [Optional] Property root > emulators > dataconnect > dataDir -#### 5.4.1. Property `root > emulators > dataconnect > dataDir` + +
| | | | ------------ | -------- | @@ -1000,7 +1367,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The directory to persist emulator data to. If set, data will be saved between runs automatically. If the --import flag is used, the current data will be overwritten by the imported data. -#### 5.4.2. Property `root > emulators > dataconnect > host` +
+
+ +
+ + 5.4.2. [Optional] Property root > emulators > dataconnect > host + + +
| | | | ------------ | -------- | @@ -1009,7 +1384,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.4.3. Property `root > emulators > dataconnect > port` +
+
+ +
+ + 5.4.3. [Optional] Property root > emulators > dataconnect > port + + +
| | | | ------------ | -------- | @@ -1018,7 +1401,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -#### 5.4.4. Property `root > emulators > dataconnect > postgresHost` +
+
+ +
+ + 5.4.4. [Optional] Property root > emulators > dataconnect > postgresHost + + +
| | | | ------------ | -------- | @@ -1027,7 +1418,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Host for the Postgres database that backs the Data Connect emulator. -#### 5.4.5. Property `root > emulators > dataconnect > postgresPort` +
+
+ +
+ + 5.4.5. [Optional] Property root > emulators > dataconnect > postgresPort + + +
| | | | ------------ | -------- | @@ -1036,7 +1435,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Port for the Postgres database that backs the Data Connect emulator. -### 5.5. Property `root > emulators > eventarc` +
+
+ +
+
+ +
+ + 5.5. [Optional] Property root > emulators > eventarc + + +
| | | | ------------------------- | ----------- | @@ -1046,12 +1456,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the EventArc emulator. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_eventarc_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_eventarc_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.5.1. [Optional] Property root > emulators > eventarc > host -#### 5.5.1. Property `root > emulators > eventarc > host` + +
| | | | ------------ | -------- | @@ -1060,7 +1470,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.5.2. Property `root > emulators > eventarc > port` +
+
+ +
+ + 5.5.2. [Optional] Property root > emulators > eventarc > port + + +
| | | | ------------ | -------- | @@ -1069,7 +1487,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -### 5.6. Property `root > emulators > extensions` +
+
+ +
+
+ +
+ + 5.6. [Optional] Property root > emulators > extensions + + +
| | | | ------------------------- | ---------------- | @@ -1079,7 +1508,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Placeholder - the Extensions emulator has no configuration options. -### 5.7. Property `root > emulators > firestore` +
+
+ +
+ + 5.7. [Optional] Property root > emulators > firestore + + +
| | | | ------------------------- | ----------- | @@ -1089,13 +1526,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firestore emulator -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_firestore_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_firestore_port ) | No | number | No | - | The port that this emulator will serve on. | -| - [websocketPort](#emulators_firestore_websocketPort ) | No | number | No | - | - | +
+ + 5.7.1. [Optional] Property root > emulators > firestore > host -#### 5.7.1. Property `root > emulators > firestore > host` + +
| | | | ------------ | -------- | @@ -1104,7 +1540,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.7.2. Property `root > emulators > firestore > port` +
+
+ +
+ + 5.7.2. [Optional] Property root > emulators > firestore > port + + +
| | | | ------------ | -------- | @@ -1113,14 +1557,33 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -#### 5.7.3. Property `root > emulators > firestore > websocketPort` +
+
+ +
+ + 5.7.3. [Optional] Property root > emulators > firestore > websocketPort + + +
| | | | ------------ | -------- | | **Type** | `number` | | **Required** | No | -### 5.8. Property `root > emulators > hosting` +
+
+ +
+
+ +
+ + 5.8. [Optional] Property root > emulators > hosting + + +
| | | | ------------------------- | ----------- | @@ -1130,12 +1593,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firebase Hosting emulator -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_hosting_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_hosting_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.8.1. [Optional] Property root > emulators > hosting > host -#### 5.8.1. Property `root > emulators > hosting > host` + +
| | | | ------------ | -------- | @@ -1144,7 +1607,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.8.2. Property `root > emulators > hosting > port` +
+
+ +
+ + 5.8.2. [Optional] Property root > emulators > hosting > port + + +
| | | | ------------ | -------- | @@ -1153,7 +1624,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -### 5.9. Property `root > emulators > hub` +
+
+ +
+
+ +
+ + 5.9. [Optional] Property root > emulators > hub + + +
| | | | ------------------------- | ----------- | @@ -1163,12 +1645,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the emulator suite hub. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_hub_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_hub_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.9.1. [Optional] Property root > emulators > hub > host -#### 5.9.1. Property `root > emulators > hub > host` + +
| | | | ------------ | -------- | @@ -1177,7 +1659,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.9.2. Property `root > emulators > hub > port` +
+
+ +
+ + 5.9.2. [Optional] Property root > emulators > hub > port + + +
| | | | ------------ | -------- | @@ -1186,7 +1676,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -### 5.10. Property `root > emulators > logging` +
+
+ +
+
+ +
+ + 5.10. [Optional] Property root > emulators > logging + + +
| | | | ------------------------- | ----------- | @@ -1196,12 +1697,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the logging emulator. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_logging_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_logging_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.10.1. [Optional] Property root > emulators > logging > host -#### 5.10.1. Property `root > emulators > logging > host` + +
| | | | ------------ | -------- | @@ -1210,7 +1711,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.10.2. Property `root > emulators > logging > port` +
+
+ +
+ + 5.10.2. [Optional] Property root > emulators > logging > port + + +
| | | | ------------ | -------- | @@ -1219,7 +1728,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -### 5.11. Property `root > emulators > pubsub` +
+
+ +
+
+ +
+ + 5.11. [Optional] Property root > emulators > pubsub + + +
| | | | ------------------------- | ----------- | @@ -1229,12 +1749,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Pub/Sub emulator -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_pubsub_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_pubsub_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.11.1. [Optional] Property root > emulators > pubsub > host -#### 5.11.1. Property `root > emulators > pubsub > host` + +
| | | | ------------ | -------- | @@ -1243,7 +1763,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.11.2. Property `root > emulators > pubsub > port` +
+
+ +
+ + 5.11.2. [Optional] Property root > emulators > pubsub > port + + +
| | | | ------------ | -------- | @@ -1252,7 +1780,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -### 5.12. Property `root > emulators > singleProjectMode` +
+
+ +
+
+ +
+ + 5.12. [Optional] Property root > emulators > singleProjectMode + + +
| | | | ------------ | --------- | @@ -1261,7 +1800,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** If true, the Emulator Suite will only allow a single project to be used at a time. -### 5.13. Property `root > emulators > storage` +
+
+ +
+ + 5.13. [Optional] Property root > emulators > storage + + +
| | | | ------------------------- | ----------- | @@ -1271,12 +1818,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firebase Storage emulator -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_storage_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_storage_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.13.1. [Optional] Property root > emulators > storage > host -#### 5.13.1. Property `root > emulators > storage > host` + +
| | | | ------------ | -------- | @@ -1285,7 +1832,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.13.2. Property `root > emulators > storage > port` +
+
+ +
+ + 5.13.2. [Optional] Property root > emulators > storage > port + + +
| | | | ------------ | -------- | @@ -1294,7 +1849,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -### 5.14. Property `root > emulators > tasks` +
+
+ +
+
+ +
+ + 5.14. [Optional] Property root > emulators > tasks + + +
| | | | ------------------------- | ----------- | @@ -1304,12 +1870,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Cloud Tasks emulator. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | -| - [host](#emulators_tasks_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_tasks_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.14.1. [Optional] Property root > emulators > tasks > host -#### 5.14.1. Property `root > emulators > tasks > host` + +
| | | | ------------ | -------- | @@ -1318,7 +1884,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.14.2. Property `root > emulators > tasks > port` +
+
+ +
+ + 5.14.2. [Optional] Property root > emulators > tasks > port + + +
| | | | ------------ | -------- | @@ -1327,7 +1901,18 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -### 5.15. Property `root > emulators > ui` +
+
+ +
+
+ +
+ + 5.15. [Optional] Property root > emulators > ui + + +
| | | | ------------------------- | ----------- | @@ -1337,13 +1922,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Emulator UI. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------- | ------- | ------- | ---------- | ---------- | --------------------------------------------- | -| - [enabled](#emulators_ui_enabled ) | No | boolean | No | - | If false, the Emulator UI will not be served. | -| - [host](#emulators_ui_host ) | No | string | No | - | The host that this emulator will serve on. | -| - [port](#emulators_ui_port ) | No | number | No | - | The port that this emulator will serve on. | +
+ + 5.15.1. [Optional] Property root > emulators > ui > enabled -#### 5.15.1. Property `root > emulators > ui > enabled` + +
| | | | ------------ | --------- | @@ -1352,7 +1936,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** If false, the Emulator UI will not be served. -#### 5.15.2. Property `root > emulators > ui > host` +
+
+ +
+ + 5.15.2. [Optional] Property root > emulators > ui > host + + +
| | | | ------------ | -------- | @@ -1361,7 +1953,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -#### 5.15.3. Property `root > emulators > ui > port` +
+
+ +
+ + 5.15.3. [Optional] Property root > emulators > ui > port + + +
| | | | ------------ | -------- | @@ -1370,7 +1970,21 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -## 6. Property `root > extensions` +
+
+ +
+
+ +
+
+ +
+ + 6. [Optional] Property root > extensions + + +
| | | | ------------------------- | ------------------------------ | @@ -1381,7 +1995,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The Firebase Extension(s) that should be deployed or emulated. -## 7. Property `root > firestore` +
+
+ +
+ + 7. [Optional] Property root > firestore + + +
| | | | ------------------------- | ---------------- | @@ -1391,11 +2013,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The Firestore rules and indexes that should be deployed or emulated. +
+ | Any of(Option) | | -------------------------------------- | | [FirestoreSingle](#firestore_anyOf_i0) | | [item 1](#firestore_anyOf_i1) | +
+ ### 7.1. Property `root > firestore > anyOf > FirestoreSingle` | | | @@ -1407,16 +2033,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Deployment options for a single Firestore database. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------- | -| - [database](#firestore_anyOf_i0_database ) | No | string | No | - | The id of the Firestore database to deploy. If omitted, defaults to '(default)' | -| - [indexes](#firestore_anyOf_i0_indexes ) | No | string | No | - | Path to the firestore indexes file | -| - [location](#firestore_anyOf_i0_location ) | No | string | No | - | The region of the Firestore database to deploy. Required when 'database' is set. | -| - [postdeploy](#firestore_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#firestore_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| - [rules](#firestore_anyOf_i0_rules ) | No | string | No | - | Path to the firestore rules file | +
+ + 7.1.1. [Optional] Property root > firestore > anyOf > item 0 > database -#### 7.1.1. Property `root > firestore > anyOf > item 0 > database` + +
| | | | ------------ | -------- | @@ -1425,7 +2047,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The id of the Firestore database to deploy. If omitted, defaults to '(default)' -#### 7.1.2. Property `root > firestore > anyOf > item 0 > indexes` +
+
+ +
+ + 7.1.2. [Optional] Property root > firestore > anyOf > item 0 > indexes + + +
| | | | ------------ | -------- | @@ -1434,7 +2064,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore indexes file -#### 7.1.3. Property `root > firestore > anyOf > item 0 > location` +
+
+ +
+ + 7.1.3. [Optional] Property root > firestore > anyOf > item 0 > location + + +
| | | | ------------ | -------- | @@ -1443,7 +2081,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The region of the Firestore database to deploy. Required when 'database' is set. -#### 7.1.4. Property `root > firestore > anyOf > item 0 > postdeploy` +
+
+ +
+ + 7.1.4. [Optional] Property root > firestore > anyOf > item 0 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -1453,11 +2099,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ------------------------------------------------- | | [item 0](#firestore_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i0_postdeploy_anyOf_i1) | +
+ ##### 7.1.4.1. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -1477,13 +2127,16 @@ If the --import flag is used, the current data will be overwritten by the import | ------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 7.1.4.2. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -1491,7 +2144,19 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -#### 7.1.5. Property `root > firestore > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 7.1.5. [Optional] Property root > firestore > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -1501,11 +2166,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ------------------------------------------------ | | [item 0](#firestore_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i0_predeploy_anyOf_i1) | +
+ ##### 7.1.5.1. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -1525,13 +2194,16 @@ If the --import flag is used, the current data will be overwritten by the import | ------------------------------------------------------------ | ----------- | | [item 0 items](#firestore_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 7.1.5.2. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -1539,7 +2211,19 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -#### 7.1.6. Property `root > firestore > anyOf > item 0 > rules` +
+ +
+ +
+
+ +
+ + 7.1.6. [Optional] Property root > firestore > anyOf > item 0 > rules + + +
| | | | ------------ | -------- | @@ -1548,6 +2232,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore rules file +
+
+ +
+
+ ### 7.2. Property `root > firestore > anyOf > item 1` | | | @@ -1569,7 +2259,7 @@ If the --import flag is used, the current data will be overwritten by the import | ----------------------------------------- | ----------- | | [item 1 items](#firestore_anyOf_i1_items) | - | -#### 7.2.1. root > firestore > anyOf > item 1 > item 1 items +#### 7.2.1. root > firestore > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -1577,11 +2267,15 @@ If the --import flag is used, the current data will be overwritten by the import | **Required** | No | | **Additional properties** | Any type allowed | +
+ | Any of(Option) | | -------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1) | +
+ ##### 7.2.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -1590,16 +2284,12 @@ If the --import flag is used, the current data will be overwritten by the import | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [database](#firestore_anyOf_i1_items_anyOf_i0_database ) | No | string | No | - | The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. | -| - [indexes](#firestore_anyOf_i1_items_anyOf_i0_indexes ) | No | string | No | - | Path to the firestore indexes file for this database | -| - [postdeploy](#firestore_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#firestore_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| - [rules](#firestore_anyOf_i1_items_anyOf_i0_rules ) | No | string | No | - | Path to the firestore rules file for this database | -| + [target](#firestore_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | The deploy target these rules and indexes should be deployed to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +
+ + 7.2.1.1.1. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database -###### 7.2.1.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database` + +
| | | | ------------ | -------- | @@ -1608,7 +2298,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. -###### 7.2.1.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes` +
+
+ +
+ + 7.2.1.1.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes + + +
| | | | ------------ | -------- | @@ -1617,7 +2315,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore indexes file for this database -###### 7.2.1.1.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` +
+
+ +
+ + 7.2.1.1.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -1627,11 +2333,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ---------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | +
+ ###### 7.2.1.1.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -1651,13 +2361,16 @@ If the --import flag is used, the current data will be overwritten by the import | ---------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 7.2.1.1.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -1665,7 +2378,19 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -###### 7.2.1.1.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 7.2.1.1.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -1675,11 +2400,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | +
+ ###### 7.2.1.1.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -1699,13 +2428,16 @@ If the --import flag is used, the current data will be overwritten by the import | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 7.2.1.1.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -1713,7 +2445,19 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -###### 7.2.1.1.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules` +
+ +
+ +
+
+ +
+ + 7.2.1.1.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules + + +
| | | | ------------ | -------- | @@ -1722,7 +2466,15 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore rules file for this database -###### 7.2.1.1.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target` +
+
+ +
+ + 7.2.1.1.6. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target + + +
| | | | ------------ | -------- | @@ -1732,6 +2484,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The deploy target these rules and indexes should be deployed to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. +
+
+ +
+
+ ##### 7.2.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -1740,16 +2498,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| + [database](#firestore_anyOf_i1_items_anyOf_i1_database ) | No | string | No | - | The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. | -| - [indexes](#firestore_anyOf_i1_items_anyOf_i1_indexes ) | No | string | No | - | Path to the firestore indexes file for this database | -| - [postdeploy](#firestore_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#firestore_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| - [rules](#firestore_anyOf_i1_items_anyOf_i1_rules ) | No | string | No | - | Path to the firestore rules file for this database | -| - [target](#firestore_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | The deploy target these rules and indexes should be deployed to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +
+ + 7.2.1.2.1. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database -###### 7.2.1.2.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database` + +
| | | | ------------ | -------- | @@ -1758,7 +2512,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. -###### 7.2.1.2.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes` +
+
+ +
+ + 7.2.1.2.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes + + +
| | | | ------------ | -------- | @@ -1767,7 +2529,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the firestore indexes file for this database -###### 7.2.1.2.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` +
+
+ +
+ + 7.2.1.2.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -1777,11 +2547,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ---------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | +
+ ###### 7.2.1.2.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -1801,13 +2575,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 7.2.1.2.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -1815,7 +2592,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -###### 7.2.1.2.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` +
+ +
+ +
+
+ +
+ + 7.2.1.2.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -1825,11 +2614,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | +
+ ###### 7.2.1.2.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -1849,13 +2642,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 7.2.1.2.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -1863,7 +2659,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -###### 7.2.1.2.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules` +
+ +
+ +
+
+ +
+ + 7.2.1.2.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules + + +
| | | | ------------ | -------- | @@ -1872,7 +2680,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the firestore rules file for this database -###### 7.2.1.2.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target` +
+
+ +
+ + 7.2.1.2.6. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target + + +
| | | | ------------ | -------- | @@ -1882,7 +2698,26 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target these rules and indexes should be deployed to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -## 8. Property `root > functions` +
+
+ +
+ +
+ +
+ +
+ +
+
+ +
+ + 8. [Optional] Property root > functions + + +
| | | | ------------------------- | ---------------- | @@ -1892,11 +2727,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Cloud Functions for Firebase that should be deployed or emulated. +
+ | Any of(Option) | | ------------------------------------- | | [FunctionConfig](#functions_anyOf_i0) | | [item 1](#functions_anyOf_i1) | +
+ ### 8.1. Property `root > functions > anyOf > FunctionConfig` | | | @@ -1906,16 +2745,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/FunctionConfig | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| - [codebase](#functions_anyOf_i0_codebase ) | No | string | No | - | The codebase that these functions are part of. You can use codebases to control which functions are deployed
ie: \`firebase deploy --only functions:my-codebase\` | -| - [ignore](#functions_anyOf_i0_ignore ) | No | array of string | No | - | Files in the source directory that should not be uploaed during dpeloyment. | -| - [postdeploy](#functions_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#functions_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| - [runtime](#functions_anyOf_i0_runtime ) | No | enum (of string) | No | - | The runtime these functions should use. | -| - [source](#functions_anyOf_i0_source ) | No | string | No | - | The directory containing your functions source code.
This directory will be archived and uploaded during deployment.
Files outside of this directory will not be included and should not be referenced from your functions code. | +
+ + 8.1.1. [Optional] Property root > functions > anyOf > item 0 > codebase -#### 8.1.1. Property `root > functions > anyOf > item 0 > codebase` + +
| | | | ------------ | -------- | @@ -1925,7 +2760,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The codebase that these functions are part of. You can use codebases to control which functions are deployed ie: `firebase deploy --only functions:my-codebase` -#### 8.1.2. Property `root > functions > anyOf > item 0 > ignore` +
+
+ +
+ + 8.1.2. [Optional] Property root > functions > anyOf > item 0 > ignore + + +
| | | | ------------ | ----------------- | @@ -1946,14 +2789,22 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------ | ----------- | | [ignore items](#functions_anyOf_i0_ignore_items) | - | -##### 8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items +##### 8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -#### 8.1.3. Property `root > functions > anyOf > item 0 > postdeploy` +
+
+ +
+ + 8.1.3. [Optional] Property root > functions > anyOf > item 0 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -1963,11 +2814,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ------------------------------------------------- | | [item 0](#functions_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#functions_anyOf_i0_postdeploy_anyOf_i1) | +
+ ##### 8.1.3.1. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -1987,13 +2842,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------------- | ----------- | | [item 0 items](#functions_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 8.1.3.2. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -2001,7 +2859,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -#### 8.1.4. Property `root > functions > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 8.1.4. [Optional] Property root > functions > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -2011,11 +2881,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ------------------------------------------------ | | [item 0](#functions_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#functions_anyOf_i0_predeploy_anyOf_i1) | +
+ ##### 8.1.4.1. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -2035,13 +2909,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------------ | ----------- | | [item 0 items](#functions_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 8.1.4.2. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -2049,7 +2926,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -#### 8.1.5. Property `root > functions > anyOf > item 0 > runtime` +
+ +
+ +
+
+ +
+ + 8.1.5. [Optional] Property root > functions > anyOf > item 0 > runtime + + +
| | | | ------------ | ------------------ | @@ -2066,7 +2955,15 @@ Must be one of: * "python312" * "python313" -#### 8.1.6. Property `root > functions > anyOf > item 0 > source` +
+
+ +
+ + 8.1.6. [Optional] Property root > functions > anyOf > item 0 > source + + +
| | | | ------------ | -------- | @@ -2077,6 +2974,12 @@ Must be one of: This directory will be archived and uploaded during deployment. Files outside of this directory will not be included and should not be referenced from your functions code. +
+
+ +
+
+ ### 8.2. Property `root > functions > anyOf > item 1` | | | @@ -2096,7 +2999,7 @@ Files outside of this directory will not be included and should not be reference | ------------------------------------------- | ----------- | | [FunctionConfig](#functions_anyOf_i1_items) | - | -#### 8.2.1. root > functions > anyOf > item 1 > FunctionConfig +#### 8.2.1. root > functions > anyOf > item 1 > FunctionConfig | | | | ------------------------- | ----------------------------------------- | @@ -2105,7 +3008,19 @@ Files outside of this directory will not be included and should not be reference | **Additional properties** | Not allowed | | **Same definition as** | [functions_anyOf_i0](#functions_anyOf_i0) | -## 9. Property `root > hosting` +
+ +
+ +
+
+ +
+ + 9. [Optional] Property root > hosting + + +
| | | | ------------------------- | ---------------- | @@ -2115,11 +3030,15 @@ Files outside of this directory will not be included and should not be reference **Description:** The Firebase Hosting site(s) that should be deployed or emulated. +
+ | Any of(Option) | | ---------------------------------- | | [HostingSingle](#hosting_anyOf_i0) | | [item 1](#hosting_anyOf_i1) | +
+ ### 9.1. Property `root > hosting > anyOf > HostingSingle` | | | @@ -2131,25 +3050,12 @@ Files outside of this directory will not be included and should not be reference **Description:** Deployment options for a single Firebase Hosting site. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [appAssociation](#hosting_anyOf_i0_appAssociation ) | No | enum (of string) | No | - | - | -| - [cleanUrls](#hosting_anyOf_i0_cleanUrls ) | No | boolean | No | - | - | -| - [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | No | object | No | In #/definitions/FrameworksBackendOptions | Options for this sites web frameworks backend. | -| - [headers](#hosting_anyOf_i0_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | -| - [i18n](#hosting_anyOf_i0_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | -| - [ignore](#hosting_anyOf_i0_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | -| - [postdeploy](#hosting_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#hosting_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| - [public](#hosting_anyOf_i0_public ) | No | string | No | - | Whether this site should publically available. | -| - [redirects](#hosting_anyOf_i0_redirects ) | No | array | No | - | A list of redirects for this site. | -| - [rewrites](#hosting_anyOf_i0_rewrites ) | No | array | No | - | A list o rewrites for this site. | -| - [site](#hosting_anyOf_i0_site ) | No | string | No | - | The site to deploy. | -| - [source](#hosting_anyOf_i0_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | -| - [target](#hosting_anyOf_i0_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | -| - [trailingSlash](#hosting_anyOf_i0_trailingSlash ) | No | boolean | No | - | - | - -#### 9.1.1. Property `root > hosting > anyOf > item 0 > appAssociation` +
+ + 9.1.1. [Optional] Property root > hosting > anyOf > item 0 > appAssociation + + +
| | | | ------------ | ------------------ | @@ -2160,14 +3066,30 @@ Must be one of: * "AUTO" * "NONE" -#### 9.1.2. Property `root > hosting > anyOf > item 0 > cleanUrls` +
+
+ +
+ + 9.1.2. [Optional] Property root > hosting > anyOf > item 0 > cleanUrls + + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -#### 9.1.3. Property `root > hosting > anyOf > item 0 > frameworksBackend` +
+
+ +
+ + 9.1.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend + + +
| | | | ------------------------- | -------------------------------------- | @@ -2178,28 +3100,12 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------------------------------------- | ------- | ----------------- | ---------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [concurrency](#hosting_anyOf_i0_frameworksBackend_concurrency ) | No | number | No | - | Number of requests a function can serve at once. | -| - [cors](#hosting_anyOf_i0_frameworksBackend_cors ) | No | string or boolean | No | - | If true, allows CORS on requests to this function.
If this is a \`string\` or \`RegExp\`, allows requests from domains that match the provided value.
If this is an \`Array\`, allows requests from domains matching at least one entry of the array.
Defaults to true for {@link https.CallableFunction} and false otherwise. | -| - [cpu](#hosting_anyOf_i0_frameworksBackend_cpu ) | No | Combination | No | - | Fractional number of CPUs to allocate to a function. | -| - [enforceAppCheck](#hosting_anyOf_i0_frameworksBackend_enforceAppCheck ) | No | boolean | No | - | Determines whether Firebase AppCheck is enforced. Defaults to false. | -| - [ingressSettings](#hosting_anyOf_i0_frameworksBackend_ingressSettings ) | No | enum (of string) | No | - | Ingress settings which control where this function can be called from. | -| - [invoker](#hosting_anyOf_i0_frameworksBackend_invoker ) | No | const | No | - | Invoker to set access control on https functions. | -| - [labels](#hosting_anyOf_i0_frameworksBackend_labels ) | No | object | No | In #/definitions/Record | User labels to set on the function. | -| - [maxInstances](#hosting_anyOf_i0_frameworksBackend_maxInstances ) | No | number | No | - | Max number of instances to be running in parallel. | -| - [memory](#hosting_anyOf_i0_frameworksBackend_memory ) | No | enum (of string) | No | - | Amount of memory to allocate to a function. | -| - [minInstances](#hosting_anyOf_i0_frameworksBackend_minInstances ) | No | number | No | - | Min number of actual instances to be running at a given time. | -| - [omit](#hosting_anyOf_i0_frameworksBackend_omit ) | No | boolean | No | - | If true, do not deploy or emulate this function. | -| - [preserveExternalChanges](#hosting_anyOf_i0_frameworksBackend_preserveExternalChanges ) | No | boolean | No | - | Controls whether function configuration modified outside of function source is preserved. Defaults to false. | -| - [region](#hosting_anyOf_i0_frameworksBackend_region ) | No | string | No | - | HTTP functions can override global options and can specify multiple regions to deploy to. | -| - [secrets](#hosting_anyOf_i0_frameworksBackend_secrets ) | No | array of string | No | - | A list of secrets used in this app. | -| - [serviceAccount](#hosting_anyOf_i0_frameworksBackend_serviceAccount ) | No | string | No | - | Specific service account for the function to run as. | -| - [timeoutSeconds](#hosting_anyOf_i0_frameworksBackend_timeoutSeconds ) | No | number | No | - | Timeout for the function in seconds, possible values are 0 to 540.
HTTPS functions can specify a higher timeout. | -| - [vpcConnector](#hosting_anyOf_i0_frameworksBackend_vpcConnector ) | No | string | No | - | Connect cloud function to specified VPC connector. | -| - [vpcConnectorEgressSettings](#hosting_anyOf_i0_frameworksBackend_vpcConnectorEgressSettings ) | No | enum (of string) | No | - | Egress settings for VPC connector. | - -##### 9.1.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > concurrency` +
+ + 9.1.3.1. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > concurrency + + +
| | | | ------------ | -------- | @@ -2208,7 +3114,15 @@ Must be one of: **Description:** Number of requests a function can serve at once. -##### 9.1.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cors` +
+
+ +
+ + 9.1.3.2. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cors + + +
| | | | ------------ | ------------------- | @@ -2220,7 +3134,15 @@ If this is a `string` or `RegExp`, allows requests from domains that match the p If this is an `Array`, allows requests from domains matching at least one entry of the array. Defaults to true for {@link https.CallableFunction} and false otherwise. -##### 9.1.3.3. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu` +
+
+ +
+ + 9.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cpu + + +
| | | | ------------------------- | ---------------- | @@ -2230,11 +3152,15 @@ Defaults to true for {@link https.CallableFunction} and false otherwise. **Description:** Fractional number of CPUs to allocate to a function. +
+ | Any of(Option) | | ---------------------------------------------------------- | | [item 0](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i0) | | [item 1](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i1) | +
+ ###### 9.1.3.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 0` | | | @@ -2244,6 +3170,9 @@ Defaults to true for {@link https.CallableFunction} and false otherwise. Specific value: `"gcf_gen1"` +
+
+ ###### 9.1.3.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 1` | | | @@ -2251,7 +3180,19 @@ Specific value: `"gcf_gen1"` | **Type** | `number` | | **Required** | No | -##### 9.1.3.4. Property `root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck` +
+ +
+ +
+
+ +
+ + 9.1.3.4. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck + + +
| | | | ------------ | --------- | @@ -2260,7 +3201,15 @@ Specific value: `"gcf_gen1"` **Description:** Determines whether Firebase AppCheck is enforced. Defaults to false. -##### 9.1.3.5. Property `root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings` +
+
+ +
+ + 9.1.3.5. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings + + +
| | | | ------------ | ------------------ | @@ -2274,7 +3223,15 @@ Must be one of: * "ALLOW_INTERNAL_AND_GCLB" * "ALLOW_INTERNAL_ONLY" -##### 9.1.3.6. Property `root > hosting > anyOf > item 0 > frameworksBackend > invoker` +
+
+ +
+ + 9.1.3.6. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > invoker + + +
| | | | ------------ | ------- | @@ -2285,7 +3242,15 @@ Must be one of: Specific value: `"public"` -##### 9.1.3.7. Property `root > hosting > anyOf > item 0 > frameworksBackend > labels` +
+
+ +
+ + 9.1.3.7. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > labels + + +
| | | | ------------------------- | ----------------------------------- | @@ -2296,7 +3261,15 @@ Specific value: `"public"` **Description:** User labels to set on the function. -##### 9.1.3.8. Property `root > hosting > anyOf > item 0 > frameworksBackend > maxInstances` +
+
+ +
+ + 9.1.3.8. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > maxInstances + + +
| | | | ------------ | -------- | @@ -2305,7 +3278,15 @@ Specific value: `"public"` **Description:** Max number of instances to be running in parallel. -##### 9.1.3.9. Property `root > hosting > anyOf > item 0 > frameworksBackend > memory` +
+
+ +
+ + 9.1.3.9. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > memory + + +
| | | | ------------ | ------------------ | @@ -2325,7 +3306,15 @@ Must be one of: * "512MiB" * "8GiB" -##### 9.1.3.10. Property `root > hosting > anyOf > item 0 > frameworksBackend > minInstances` +
+
+ +
+ + 9.1.3.10. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > minInstances + + +
| | | | ------------ | -------- | @@ -2334,7 +3323,15 @@ Must be one of: **Description:** Min number of actual instances to be running at a given time. -##### 9.1.3.11. Property `root > hosting > anyOf > item 0 > frameworksBackend > omit` +
+
+ +
+ + 9.1.3.11. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > omit + + +
| | | | ------------ | --------- | @@ -2343,7 +3340,15 @@ Must be one of: **Description:** If true, do not deploy or emulate this function. -##### 9.1.3.12. Property `root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges` +
+
+ +
+ + 9.1.3.12. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges + + +
| | | | ------------ | --------- | @@ -2352,7 +3357,15 @@ Must be one of: **Description:** Controls whether function configuration modified outside of function source is preserved. Defaults to false. -##### 9.1.3.13. Property `root > hosting > anyOf > item 0 > frameworksBackend > region` +
+
+ +
+ + 9.1.3.13. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > region + + +
| | | | ------------ | -------- | @@ -2361,7 +3374,15 @@ Must be one of: **Description:** HTTP functions can override global options and can specify multiple regions to deploy to. -##### 9.1.3.14. Property `root > hosting > anyOf > item 0 > frameworksBackend > secrets` +
+
+ +
+ + 9.1.3.14. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > secrets + + +
| | | | ------------ | ----------------- | @@ -2382,14 +3403,22 @@ Must be one of: | ------------------------------------------------------------------ | ----------- | | [secrets items](#hosting_anyOf_i0_frameworksBackend_secrets_items) | - | -###### 9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items +###### 9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -##### 9.1.3.15. Property `root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount` +
+
+ +
+ + 9.1.3.15. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount + + +
| | | | ------------ | -------- | @@ -2398,7 +3427,15 @@ Must be one of: **Description:** Specific service account for the function to run as. -##### 9.1.3.16. Property `root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds` +
+
+ +
+ + 9.1.3.16. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds + + +
| | | | ------------ | -------- | @@ -2408,7 +3445,15 @@ Must be one of: **Description:** Timeout for the function in seconds, possible values are 0 to 540. HTTPS functions can specify a higher timeout. -##### 9.1.3.17. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector` +
+
+ +
+ + 9.1.3.17. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector + + +
| | | | ------------ | -------- | @@ -2417,7 +3462,15 @@ HTTPS functions can specify a higher timeout. **Description:** Connect cloud function to specified VPC connector. -##### 9.1.3.18. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings` +
+
+ +
+ + 9.1.3.18. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings + + +
| | | | ------------ | ------------------ | @@ -2430,7 +3483,18 @@ Must be one of: * "ALL_TRAFFIC" * "PRIVATE_RANGES_ONLY" -#### 9.1.4. Property `root > hosting > anyOf > item 0 > headers` +
+
+ +
+
+ +
+ + 9.1.4. [Optional] Property root > hosting > anyOf > item 0 > headers + + +
| | | | ------------ | ------- | @@ -2451,7 +3515,7 @@ Must be one of: | ------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | -##### 9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders +##### 9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders | | | | ------------------------- | ---------------------------- | @@ -2462,12 +3526,16 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. +
+ | Any of(Option) | | -------------------------------------------------- | | [item 0](#hosting_anyOf_i0_headers_items_anyOf_i0) | | [item 1](#hosting_anyOf_i0_headers_items_anyOf_i1) | | [item 2](#hosting_anyOf_i0_headers_items_anyOf_i2) | +
+ ###### 9.1.4.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0` | | | @@ -2476,12 +3544,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ---------------------------------------------------------------------- | -| + [glob](#hosting_anyOf_i0_headers_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | -| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i0_headers ) | No | array of object | No | - | - | +
+ + 9.1.4.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob -###### 9.1.4.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob` + +
| | | | ------------ | -------- | @@ -2490,7 +3558,15 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -###### 9.1.4.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers` +
+
+ +
+ + 9.1.4.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers + + +
| | | | ------------ | ----------------- | @@ -2509,7 +3585,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items) | - | -###### 9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items +###### 9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items | | | | ------------------------- | ----------- | @@ -2517,12 +3593,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | -| + [key](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_key ) | No | string | No | - | The header to set. | -| + [value](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_value ) | No | string | No | - | The value to set this header to. | +
+ + 9.1.4.1.1.2.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key -###### 9.1.4.1.1.2.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key` + +
| | | | ------------ | -------- | @@ -2531,7 +3607,15 @@ Must be one of: **Description:** The header to set. -###### 9.1.4.1.1.2.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value` +
+
+ +
+ + 9.1.4.1.1.2.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value + + +
| | | | ------------ | -------- | @@ -2540,6 +3624,15 @@ Must be one of: **Description:** The value to set this header to. +
+
+ +
+
+ +
+
+ ###### 9.1.4.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1` | | | @@ -2548,12 +3641,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ---------------------------------------------- | -| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i1_headers ) | No | array of object | No | - | - | -| + [source](#hosting_anyOf_i0_headers_items_anyOf_i1_source ) | No | string | No | - | A file path that this setting should apply to. | +
+ + 9.1.4.1.2.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers -###### 9.1.4.1.2.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers` + +
| | | | ------------ | ----------------- | @@ -2572,7 +3665,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items) | - | -###### 9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items +###### 9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items | | | | ------------------------- | ----------- | @@ -2580,12 +3673,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | -| + [key](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_key ) | No | string | No | - | The header to set. | -| + [value](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_value ) | No | string | No | - | The value to set this header to. | +
+ + 9.1.4.1.2.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key -###### 9.1.4.1.2.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key` + +
| | | | ------------ | -------- | @@ -2594,7 +3687,15 @@ Must be one of: **Description:** The header to set. -###### 9.1.4.1.2.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value` +
+
+ +
+ + 9.1.4.1.2.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value + + +
| | | | ------------ | -------- | @@ -2603,7 +3704,18 @@ Must be one of: **Description:** The value to set this header to. -###### 9.1.4.1.2.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source` +
+
+ +
+
+ +
+ + 9.1.4.1.2.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source + + +
| | | | ------------ | -------- | @@ -2612,6 +3724,12 @@ Must be one of: **Description:** A file path that this setting should apply to. +
+
+ +
+
+ ###### 9.1.4.1.3. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2` | | | @@ -2620,12 +3738,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------- | -| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i2_headers ) | No | array of object | No | - | - | -| + [regex](#hosting_anyOf_i0_headers_items_anyOf_i2_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +
+ + 9.1.4.1.3.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers -###### 9.1.4.1.3.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers` + +
| | | | ------------ | ----------------- | @@ -2644,7 +3762,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items) | - | -###### 9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items +###### 9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items | | | | ------------------------- | ----------- | @@ -2652,12 +3770,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | -| + [key](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_key ) | No | string | No | - | The header to set. | -| + [value](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_value ) | No | string | No | - | The value to set this header to. | +
+ + 9.1.4.1.3.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key -###### 9.1.4.1.3.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key` + +
| | | | ------------ | -------- | @@ -2666,7 +3784,15 @@ Must be one of: **Description:** The header to set. -###### 9.1.4.1.3.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value` +
+
+ +
+ + 9.1.4.1.3.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value + + +
| | | | ------------ | -------- | @@ -2675,7 +3801,18 @@ Must be one of: **Description:** The value to set this header to. -###### 9.1.4.1.3.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex` +
+
+ +
+
+ +
+ + 9.1.4.1.3.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex + + +
| | | | ------------ | -------- | @@ -2684,7 +3821,22 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -#### 9.1.5. Property `root > hosting > anyOf > item 0 > i18n` +
+
+ +
+ +
+ +
+
+ +
+ + 9.1.5. [Optional] Property root > hosting > anyOf > item 0 > i18n + + +
| | | | ------------------------- | ----------- | @@ -2696,11 +3848,12 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | -| + [root](#hosting_anyOf_i0_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | +
+ + 9.1.5.1. [Required] Property root > hosting > anyOf > item 0 > i18n > root -##### 9.1.5.1. Property `root > hosting > anyOf > item 0 > i18n > root` + +
| | | | ------------ | -------- | @@ -2709,7 +3862,18 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -#### 9.1.6. Property `root > hosting > anyOf > item 0 > ignore` +
+
+ +
+
+ +
+ + 9.1.6. [Optional] Property root > hosting > anyOf > item 0 > ignore + + +
| | | | ------------ | ----------------- | @@ -2730,14 +3894,22 @@ for instructions on how to enable interntionalization for your site. | ---------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i0_ignore_items) | - | -##### 9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items +##### 9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -#### 9.1.7. Property `root > hosting > anyOf > item 0 > postdeploy` +
+
+ +
+ + 9.1.7. [Optional] Property root > hosting > anyOf > item 0 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -2747,11 +3919,15 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ----------------------------------------------- | | [item 0](#hosting_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i0_postdeploy_anyOf_i1) | +
+ ##### 9.1.7.1. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -2771,13 +3947,16 @@ for instructions on how to enable interntionalization for your site. | ----------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 9.1.7.2. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -2785,7 +3964,19 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -#### 9.1.8. Property `root > hosting > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 9.1.8. [Optional] Property root > hosting > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -2795,11 +3986,15 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ---------------------------------------------- | | [item 0](#hosting_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i0_predeploy_anyOf_i1) | +
+ ##### 9.1.8.1. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -2819,13 +4014,16 @@ for instructions on how to enable interntionalization for your site. | ---------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 9.1.8.2. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -2833,7 +4031,19 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -#### 9.1.9. Property `root > hosting > anyOf > item 0 > public` +
+ +
+ +
+
+ +
+ + 9.1.9. [Optional] Property root > hosting > anyOf > item 0 > public + + +
| | | | ------------ | -------- | @@ -2842,7 +4052,15 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -#### 9.1.10. Property `root > hosting > anyOf > item 0 > redirects` +
+
+ +
+ + 9.1.10. [Optional] Property root > hosting > anyOf > item 0 > redirects + + +
| | | | ------------ | ------- | @@ -2863,7 +4081,7 @@ for instructions on how to enable interntionalization for your site. | ----------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -##### 9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects +##### 9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects | | | | ------------------------- | ------------------------------ | @@ -2874,12 +4092,16 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. +
+ | Any of(Option) | | ---------------------------------------------------- | | [item 0](#hosting_anyOf_i0_redirects_items_anyOf_i0) | | [item 1](#hosting_anyOf_i0_redirects_items_anyOf_i1) | | [item 2](#hosting_anyOf_i0_redirects_items_anyOf_i2) | +
+ ###### 9.1.10.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0` | | | @@ -2888,13 +4110,12 @@ for instructions on how to enable interntionalization for your site. | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | -| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i0_destination ) | No | string | No | - | The destination to redirect to. | -| + [glob](#hosting_anyOf_i0_redirects_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | -| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i0_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | +
+ + 9.1.10.1.1.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination -###### 9.1.10.1.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination` + +
| | | | ------------ | -------- | @@ -2903,7 +4124,15 @@ for instructions on how to enable interntionalization for your site. **Description:** The destination to redirect to. -###### 9.1.10.1.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob` +
+
+ +
+ + 9.1.10.1.1.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob + + +
| | | | ------------ | -------- | @@ -2912,7 +4141,15 @@ for instructions on how to enable interntionalization for your site. **Description:** A glob pattern describing the paths that this setting should apply to. -###### 9.1.10.1.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type` +
+
+ +
+ + 9.1.10.1.1.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type + + +
| | | | ------------ | ------------------- | @@ -2926,6 +4163,12 @@ Must be one of: * 301 * 302 +
+
+ +
+
+ ###### 9.1.10.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1` | | | @@ -2934,13 +4177,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | -| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i1_destination ) | No | string | No | - | The destination to redirect to. | -| + [source](#hosting_anyOf_i0_redirects_items_anyOf_i1_source ) | No | string | No | - | A file path that this setting should apply to. | -| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i1_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | +
+ + 9.1.10.1.2.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination -###### 9.1.10.1.2.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination` + +
| | | | ------------ | -------- | @@ -2949,7 +4191,15 @@ Must be one of: **Description:** The destination to redirect to. -###### 9.1.10.1.2.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source` +
+
+ +
+ + 9.1.10.1.2.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source + + +
| | | | ------------ | -------- | @@ -2958,7 +4208,15 @@ Must be one of: **Description:** A file path that this setting should apply to. -###### 9.1.10.1.2.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type` +
+
+ +
+ + 9.1.10.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type + + +
| | | | ------------ | ------------------- | @@ -2972,6 +4230,12 @@ Must be one of: * 301 * 302 +
+
+ +
+
+ ###### 9.1.10.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2` | | | @@ -2980,13 +4244,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | -| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i2_destination ) | No | string | No | - | The destination to redirect to. | -| + [regex](#hosting_anyOf_i0_redirects_items_anyOf_i2_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | -| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i2_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | +
+ + 9.1.10.1.3.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination -###### 9.1.10.1.3.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination` + +
| | | | ------------ | -------- | @@ -2995,7 +4258,15 @@ Must be one of: **Description:** The destination to redirect to. -###### 9.1.10.1.3.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex` +
+
+ +
+ + 9.1.10.1.3.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex + + +
| | | | ------------ | -------- | @@ -3004,7 +4275,15 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -###### 9.1.10.1.3.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type` +
+
+ +
+ + 9.1.10.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type + + +
| | | | ------------ | ------------------- | @@ -3018,7 +4297,22 @@ Must be one of: * 301 * 302 -#### 9.1.11. Property `root > hosting > anyOf > item 0 > rewrites` +
+
+ +
+ +
+ +
+
+ +
+ + 9.1.11. [Optional] Property root > hosting > anyOf > item 0 > rewrites + + +
| | | | ------------ | ------- | @@ -3039,7 +4333,7 @@ Must be one of: | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -##### 9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites +##### 9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites | | | | ------------------------- | ----------------------------- | @@ -3050,6 +4344,8 @@ Must be one of: **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. +
+ | Any of(Option) | | ----------------------------------------------------- | | [item 0](#hosting_anyOf_i0_rewrites_items_anyOf_i0) | @@ -3068,6 +4364,8 @@ Must be one of: | [item 13](#hosting_anyOf_i0_rewrites_items_anyOf_i13) | | [item 14](#hosting_anyOf_i0_rewrites_items_anyOf_i14) | +
+ ###### 9.1.11.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0` | | | @@ -3076,19 +4374,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | -| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i0_destination ) | No | string | No | - | - | -| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +
+ + 9.1.11.1.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination -###### 9.1.11.1.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination` + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -###### 9.1.11.1.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob` +
+
+ +
+ + 9.1.11.1.1.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob + + +
| | | | ------------ | -------- | @@ -3097,6 +4403,12 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1` | | | @@ -3105,20 +4417,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | -| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i1_function ) | No | string | No | - | - | -| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i1_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i1_region ) | No | string | No | - | - | +
+ + 9.1.11.1.2.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function -###### 9.1.11.1.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function` + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -###### 9.1.11.1.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob` +
+
+ +
+ + 9.1.11.1.2.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob + + +
| | | | ------------ | -------- | @@ -3127,13 +4446,27 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -###### 9.1.11.1.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region` +
+
+ +
+ + 9.1.11.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ +
+
+ ###### 9.1.11.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2` | | | @@ -3142,12 +4475,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | -| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function ) | No | object | No | - | - | -| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i2_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +
+ + 9.1.11.1.3.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function -###### 9.1.11.1.3.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function` + +
| | | | ------------------------- | ----------- | @@ -3155,13 +4488,12 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | -| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | -| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_region ) | No | string | No | - | - | +
+ + 9.1.11.1.3.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId -###### 9.1.11.1.3.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId` + +
| | | | ------------ | -------- | @@ -3170,7 +4502,15 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -###### 9.1.11.1.3.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag` +
+
+ +
+ + 9.1.11.1.3.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag + + +
| | | | ------------ | --------- | @@ -3179,14 +4519,33 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -###### 9.1.11.1.3.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region` +
+
+ +
+ + 9.1.11.1.3.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.1.11.1.3.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob` +
+
+ +
+
+ +
+ + 9.1.11.1.3.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob + + +
| | | | ------------ | -------- | @@ -3195,6 +4554,12 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.4. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3` | | | @@ -3203,12 +4568,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | -| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i3_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | -| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run ) | No | object | No | - | - | +
+ + 9.1.11.1.4.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob -###### 9.1.11.1.4.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob` + +
| | | | ------------ | -------- | @@ -3217,7 +4582,15 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -###### 9.1.11.1.4.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run` +
+
+ +
+ + 9.1.11.1.4.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run + + +
| | | | ------------------------- | ----------- | @@ -3225,13 +4598,12 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | -| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_region ) | No | string | No | - | - | -| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | +
+ + 9.1.11.1.4.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag -###### 9.1.11.1.4.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag` + +
| | | | ------------ | --------- | @@ -3240,14 +4612,30 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -###### 9.1.11.1.4.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region` +
+
+ +
+ + 9.1.11.1.4.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.1.11.1.4.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId` +
+
+ +
+ + 9.1.11.1.4.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId + + +
| | | | ------------ | -------- | @@ -3256,6 +4644,15 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. +
+
+ +
+
+ +
+
+ ###### 9.1.11.1.5. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4` | | | @@ -3264,19 +4661,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------- | -| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i4_dynamicLinks ) | No | boolean | No | - | - | -| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i4_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +
+ + 9.1.11.1.5.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks -###### 9.1.11.1.5.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks` + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -###### 9.1.11.1.5.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob` +
+
+ +
+ + 9.1.11.1.5.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob + + +
| | | | ------------ | -------- | @@ -3285,6 +4690,12 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.6. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5` | | | @@ -3293,19 +4704,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | -| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i5_destination ) | No | string | No | - | - | -| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i5_source ) | No | string | No | - | A file path that this setting should apply to. | +
+ + 9.1.11.1.6.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination -###### 9.1.11.1.6.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination` + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -###### 9.1.11.1.6.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source` +
+
+ +
+ + 9.1.11.1.6.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source + + +
| | | | ------------ | -------- | @@ -3314,6 +4733,12 @@ Must be one of: **Description:** A file path that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.7. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6` | | | @@ -3322,27 +4747,42 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | -| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i6_function ) | No | string | No | - | - | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i6_region ) | No | string | No | - | - | -| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i6_source ) | No | string | No | - | A file path that this setting should apply to. | +
+ + 9.1.11.1.7.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function -###### 9.1.11.1.7.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function` + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -###### 9.1.11.1.7.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region` +
+
+ +
+ + 9.1.11.1.7.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.1.11.1.7.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source` +
+
+ +
+ + 9.1.11.1.7.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source + + +
| | | | ------------ | -------- | @@ -3351,6 +4791,12 @@ Must be one of: **Description:** A file path that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.8. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7` | | | @@ -3359,12 +4805,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | -| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function ) | No | object | No | - | - | -| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i7_source ) | No | string | No | - | A file path that this setting should apply to. | +
+ + 9.1.11.1.8.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function -###### 9.1.11.1.8.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function` + +
| | | | ------------------------- | ----------- | @@ -3372,13 +4818,12 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | -| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | -| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_region ) | No | string | No | - | - | +
+ + 9.1.11.1.8.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId -###### 9.1.11.1.8.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId` + +
| | | | ------------ | -------- | @@ -3387,7 +4832,15 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -###### 9.1.11.1.8.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag` +
+
+ +
+ + 9.1.11.1.8.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag + + +
| | | | ------------ | --------- | @@ -3396,14 +4849,33 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -###### 9.1.11.1.8.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region` +
+
+ +
+ + 9.1.11.1.8.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.1.11.1.8.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source` +
+
+ +
+
+ +
+ + 9.1.11.1.8.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source + + +
| | | | ------------ | -------- | @@ -3412,6 +4884,12 @@ Must be one of: **Description:** A file path that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.9. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8` | | | @@ -3420,12 +4898,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | -| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run ) | No | object | No | - | - | -| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i8_source ) | No | string | No | - | A file path that this setting should apply to. | +
+ + 9.1.11.1.9.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run -###### 9.1.11.1.9.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run` + +
| | | | ------------------------- | ----------- | @@ -3433,13 +4911,12 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | -| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_region ) | No | string | No | - | - | -| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | +
+ + 9.1.11.1.9.1.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag -###### 9.1.11.1.9.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag` + +
| | | | ------------ | --------- | @@ -3448,14 +4925,30 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -###### 9.1.11.1.9.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region` +
+
+ +
+ + 9.1.11.1.9.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.1.11.1.9.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId` +
+
+ +
+ + 9.1.11.1.9.1.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId + + +
| | | | ------------ | -------- | @@ -3464,7 +4957,18 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. -###### 9.1.11.1.9.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source` +
+
+ +
+
+ +
+ + 9.1.11.1.9.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source + + +
| | | | ------------ | -------- | @@ -3473,6 +4977,12 @@ Must be one of: **Description:** A file path that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.10. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9` | | | @@ -3481,19 +4991,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------- | -| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i9_dynamicLinks ) | No | boolean | No | - | - | -| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i9_source ) | No | string | No | - | A file path that this setting should apply to. | +
+ + 9.1.11.1.10.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks -###### 9.1.11.1.10.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks` + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -###### 9.1.11.1.10.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source` +
+
+ +
+ + 9.1.11.1.10.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source + + +
| | | | ------------ | -------- | @@ -3502,6 +5020,12 @@ Must be one of: **Description:** A file path that this setting should apply to. +
+
+ +
+
+ ###### 9.1.11.1.11. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10` | | | @@ -3510,19 +5034,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | -| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i10_destination ) | No | string | No | - | - | -| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i10_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +
+ + 9.1.11.1.11.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination -###### 9.1.11.1.11.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination` + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -###### 9.1.11.1.11.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex` +
+
+ +
+ + 9.1.11.1.11.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex + + +
| | | | ------------ | -------- | @@ -3531,6 +5063,12 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * +
+
+ +
+
+ ###### 9.1.11.1.12. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11` | | | @@ -3539,20 +5077,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | -| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i11_function ) | No | string | No | - | - | -| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i11_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i11_region ) | No | string | No | - | - | +
+ + 9.1.11.1.12.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function -###### 9.1.11.1.12.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function` + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -###### 9.1.11.1.12.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex` +
+
+ +
+ + 9.1.11.1.12.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex + + +
| | | | ------------ | -------- | @@ -3561,13 +5106,27 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -###### 9.1.11.1.12.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region` +
+
+ +
+ + 9.1.11.1.12.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ +
+
+ ###### 9.1.11.1.13. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12` | | | @@ -3576,12 +5135,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | -| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function ) | No | object | No | - | - | -| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i12_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +
+ + 9.1.11.1.13.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function -###### 9.1.11.1.13.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function` + +
| | | | ------------------------- | ----------- | @@ -3589,13 +5148,12 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | -| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | -| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_region ) | No | string | No | - | - | +
+ + 9.1.11.1.13.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId -###### 9.1.11.1.13.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId` + +
| | | | ------------ | -------- | @@ -3604,7 +5162,15 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -###### 9.1.11.1.13.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag` +
+
+ +
+ + 9.1.11.1.13.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag + + +
| | | | ------------ | --------- | @@ -3613,14 +5179,33 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -###### 9.1.11.1.13.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region` +
+
+ +
+ + 9.1.11.1.13.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.1.11.1.13.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex` +
+
+ +
+
+ +
+ + 9.1.11.1.13.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex + + +
| | | | ------------ | -------- | @@ -3629,6 +5214,12 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * +
+
+ +
+
+ ###### 9.1.11.1.14. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13` | | | @@ -3637,12 +5228,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | -| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i13_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | -| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run ) | No | object | No | - | - | +
+ + 9.1.11.1.14.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex -###### 9.1.11.1.14.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex` + +
| | | | ------------ | -------- | @@ -3651,7 +5242,15 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -###### 9.1.11.1.14.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run` +
+
+ +
+ + 9.1.11.1.14.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run + + +
| | | | ------------------------- | ----------- | @@ -3659,13 +5258,12 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | -| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | -| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_region ) | No | string | No | - | - | -| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | +
+ + 9.1.11.1.14.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag -###### 9.1.11.1.14.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag` + +
| | | | ------------ | --------- | @@ -3674,14 +5272,30 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -###### 9.1.11.1.14.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region` +
+
+ +
+ + 9.1.11.1.14.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region + + +
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.1.11.1.14.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId` +
+
+ +
+ + 9.1.11.1.14.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId + + +
| | | | ------------ | -------- | @@ -3690,6 +5304,15 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. +
+
+ +
+
+ +
+
+ ###### 9.1.11.1.15. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14` | | | @@ -3698,19 +5321,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | --------------------------------------------------------------------------- | -| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i14_dynamicLinks ) | No | boolean | No | - | - | -| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i14_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +
+ + 9.1.11.1.15.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks -###### 9.1.11.1.15.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks` + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -###### 9.1.11.1.15.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex` +
+
+ +
+ + 9.1.11.1.15.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex + + +
| | | | ------------ | -------- | @@ -3719,7 +5350,22 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -#### 9.1.12. Property `root > hosting > anyOf > item 0 > site` +
+
+ +
+ +
+ +
+
+ +
+ + 9.1.12. [Optional] Property root > hosting > anyOf > item 0 > site + + +
| | | | ------------ | -------- | @@ -3728,7 +5374,15 @@ Must be one of: **Description:** The site to deploy. -#### 9.1.13. Property `root > hosting > anyOf > item 0 > source` +
+
+ +
+ + 9.1.13. [Optional] Property root > hosting > anyOf > item 0 > source + + +
| | | | ------------ | -------- | @@ -3737,7 +5391,15 @@ Must be one of: **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -#### 9.1.14. Property `root > hosting > anyOf > item 0 > target` +
+
+ +
+ + 9.1.14. [Optional] Property root > hosting > anyOf > item 0 > target + + +
| | | | ------------ | -------- | @@ -3747,13 +5409,27 @@ Must be one of: **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -#### 9.1.15. Property `root > hosting > anyOf > item 0 > trailingSlash` +
+
+ +
+ + 9.1.15. [Optional] Property root > hosting > anyOf > item 0 > trailingSlash + + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | +
+
+ +
+
+ ### 9.2. Property `root > hosting > anyOf > item 1` | | | @@ -3775,7 +5451,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------- | ----------- | | [item 1 items](#hosting_anyOf_i1_items) | - | -#### 9.2.1. root > hosting > anyOf > item 1 > item 1 items +#### 9.2.1. root > hosting > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -3783,11 +5459,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Any type allowed | +
+ | Any of(Option) | | ------------------------------------------ | | [item 0](#hosting_anyOf_i1_items_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1) | +
+ ##### 9.2.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -3796,25 +5476,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [appAssociation](#hosting_anyOf_i1_items_anyOf_i0_appAssociation ) | No | enum (of string) | No | - | - | -| - [cleanUrls](#hosting_anyOf_i1_items_anyOf_i0_cleanUrls ) | No | boolean | No | - | - | -| - [frameworksBackend](#hosting_anyOf_i1_items_anyOf_i0_frameworksBackend ) | No | object | No | Same as [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | Options for this sites web frameworks backend. | -| - [headers](#hosting_anyOf_i1_items_anyOf_i0_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | -| - [i18n](#hosting_anyOf_i1_items_anyOf_i0_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | -| - [ignore](#hosting_anyOf_i1_items_anyOf_i0_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | -| - [postdeploy](#hosting_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#hosting_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| - [public](#hosting_anyOf_i1_items_anyOf_i0_public ) | No | string | No | - | Whether this site should publically available. | -| - [redirects](#hosting_anyOf_i1_items_anyOf_i0_redirects ) | No | array | No | - | A list of redirects for this site. | -| - [rewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites ) | No | array | No | - | A list o rewrites for this site. | -| - [site](#hosting_anyOf_i1_items_anyOf_i0_site ) | No | string | No | - | The site to deploy | -| - [source](#hosting_anyOf_i1_items_anyOf_i0_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | -| + [target](#hosting_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | -| - [trailingSlash](#hosting_anyOf_i1_items_anyOf_i0_trailingSlash ) | No | boolean | No | - | - | - -###### 9.2.1.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation` +
+ + 9.2.1.1.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation + + +
| | | | ------------ | ------------------ | @@ -3825,14 +5492,30 @@ Must be one of: * "AUTO" * "NONE" -###### 9.2.1.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls` +
+
+ +
+ + 9.2.1.1.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls + + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -###### 9.2.1.1.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend` +
+
+ +
+ + 9.2.1.1.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend + + +
| | | | ------------------------- | -------------------------------------------------------- | @@ -3843,7 +5526,15 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -###### 9.2.1.1.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers` +
+
+ +
+ + 9.2.1.1.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers + + +
| | | | ------------ | ------- | @@ -3864,7 +5555,7 @@ Must be one of: | ---------------------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | -###### 9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders +###### 9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders | | | | ------------------------- | ----------------------------------------------------------------- | @@ -3875,7 +5566,15 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -###### 9.2.1.1.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n` +
+
+ +
+ + 9.2.1.1.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n + + +
| | | | ------------------------- | ----------- | @@ -3887,11 +5586,12 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | -| + [root](#hosting_anyOf_i1_items_anyOf_i0_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | +
+ + 9.2.1.1.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root -###### 9.2.1.1.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root` + +
| | | | ------------ | -------- | @@ -3900,7 +5600,18 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -###### 9.2.1.1.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore` +
+
+ +
+
+ +
+ + 9.2.1.1.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore + + +
| | | | ------------ | ----------------- | @@ -3921,14 +5632,22 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i1_items_anyOf_i0_ignore_items) | - | -###### 9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items +###### 9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.2.1.1.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` +
+
+ +
+ + 9.2.1.1.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -3938,11 +5657,15 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | +
+ ###### 9.2.1.1.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -3962,13 +5685,16 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 9.2.1.1.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -3976,7 +5702,19 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -###### 9.2.1.1.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 9.2.1.1.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -3986,11 +5724,15 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | +
+ ###### 9.2.1.1.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -4010,13 +5752,16 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 9.2.1.1.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -4024,7 +5769,19 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -###### 9.2.1.1.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public` +
+ +
+ +
+
+ +
+ + 9.2.1.1.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public + + +
| | | | ------------ | -------- | @@ -4033,7 +5790,15 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -###### 9.2.1.1.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects` +
+
+ +
+ + 9.2.1.1.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects + + +
| | | | ------------ | ------- | @@ -4054,7 +5819,7 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -###### 9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects +###### 9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects | | | | ------------------------- | --------------------------------------------------------------------- | @@ -4065,7 +5830,15 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -###### 9.2.1.1.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites` +
+
+ +
+ + 9.2.1.1.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites + + +
| | | | ------------ | ------- | @@ -4086,7 +5859,7 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -###### 9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites +###### 9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites | | | | ------------------------- | ------------------------------------------------------------------- | @@ -4097,7 +5870,15 @@ for instructions on how to enable interntionalization for your site. **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -###### 9.2.1.1.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site` +
+
+ +
+ + 9.2.1.1.12. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site + + +
| | | | ------------ | -------- | @@ -4106,7 +5887,15 @@ for instructions on how to enable interntionalization for your site. **Description:** The site to deploy -###### 9.2.1.1.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source` +
+
+ +
+ + 9.2.1.1.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source + + +
| | | | ------------ | -------- | @@ -4115,7 +5904,15 @@ for instructions on how to enable interntionalization for your site. **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -###### 9.2.1.1.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target` +
+
+ +
+ + 9.2.1.1.14. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target + + +
| | | | ------------ | -------- | @@ -4125,13 +5922,27 @@ for instructions on how to enable interntionalization for your site. **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -###### 9.2.1.1.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash` +
+
+ +
+ + 9.2.1.1.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash + + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | +
+
+ +
+
+ ##### 9.2.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -4140,25 +5951,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [appAssociation](#hosting_anyOf_i1_items_anyOf_i1_appAssociation ) | No | enum (of string) | No | - | - | -| - [cleanUrls](#hosting_anyOf_i1_items_anyOf_i1_cleanUrls ) | No | boolean | No | - | - | -| - [frameworksBackend](#hosting_anyOf_i1_items_anyOf_i1_frameworksBackend ) | No | object | No | Same as [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | Options for this sites web frameworks backend. | -| - [headers](#hosting_anyOf_i1_items_anyOf_i1_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | -| - [i18n](#hosting_anyOf_i1_items_anyOf_i1_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | -| - [ignore](#hosting_anyOf_i1_items_anyOf_i1_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | -| - [postdeploy](#hosting_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#hosting_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| - [public](#hosting_anyOf_i1_items_anyOf_i1_public ) | No | string | No | - | Whether this site should publically available. | -| - [redirects](#hosting_anyOf_i1_items_anyOf_i1_redirects ) | No | array | No | - | A list of redirects for this site. | -| - [rewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites ) | No | array | No | - | A list o rewrites for this site. | -| + [site](#hosting_anyOf_i1_items_anyOf_i1_site ) | No | string | No | - | The site to deploy | -| - [source](#hosting_anyOf_i1_items_anyOf_i1_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | -| - [target](#hosting_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | -| - [trailingSlash](#hosting_anyOf_i1_items_anyOf_i1_trailingSlash ) | No | boolean | No | - | - | - -###### 9.2.1.2.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation` +
+ + 9.2.1.2.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation + + +
| | | | ------------ | ------------------ | @@ -4169,14 +5967,30 @@ Must be one of: * "AUTO" * "NONE" -###### 9.2.1.2.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls` +
+
+ +
+ + 9.2.1.2.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls + + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -###### 9.2.1.2.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend` +
+
+ +
+ + 9.2.1.2.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend + + +
| | | | ------------------------- | -------------------------------------------------------- | @@ -4187,7 +6001,15 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -###### 9.2.1.2.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers` +
+
+ +
+ + 9.2.1.2.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers + + +
| | | | ------------ | ------- | @@ -4208,7 +6030,7 @@ Must be one of: | ---------------------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i1_headers_items) | Extra headers that should be sent when serving this path. | -###### 9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders +###### 9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders | | | | ------------------------- | ----------------------------------------------------------------- | @@ -4219,7 +6041,15 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -###### 9.2.1.2.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n` +
+
+ +
+ + 9.2.1.2.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n + + +
| | | | ------------------------- | ----------- | @@ -4231,11 +6061,12 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | -| + [root](#hosting_anyOf_i1_items_anyOf_i1_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | +
+ + 9.2.1.2.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root -###### 9.2.1.2.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root` + +
| | | | ------------ | -------- | @@ -4244,7 +6075,18 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -###### 9.2.1.2.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore` +
+
+ +
+
+ +
+ + 9.2.1.2.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore + + +
| | | | ------------ | ----------------- | @@ -4265,14 +6107,22 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i1_items_anyOf_i1_ignore_items) | - | -###### 9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items +###### 9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -###### 9.2.1.2.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` +
+
+ +
+ + 9.2.1.2.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -4282,11 +6132,15 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | +
+ ###### 9.2.1.2.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -4306,13 +6160,16 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 9.2.1.2.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -4320,7 +6177,19 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -###### 9.2.1.2.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` +
+ +
+ +
+
+ +
+ + 9.2.1.2.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -4330,11 +6199,15 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | +
+ ###### 9.2.1.2.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -4354,13 +6227,16 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 9.2.1.2.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -4368,7 +6244,19 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -###### 9.2.1.2.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public` +
+ +
+ +
+
+ +
+ + 9.2.1.2.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public + + +
| | | | ------------ | -------- | @@ -4377,7 +6265,15 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -###### 9.2.1.2.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects` +
+
+ +
+ + 9.2.1.2.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects + + +
| | | | ------------ | ------- | @@ -4398,7 +6294,7 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i1_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -###### 9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects +###### 9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects | | | | ------------------------- | --------------------------------------------------------------------- | @@ -4409,7 +6305,15 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -###### 9.2.1.2.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites` +
+
+ +
+ + 9.2.1.2.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites + + +
| | | | ------------ | ------- | @@ -4430,7 +6334,7 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -###### 9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites +###### 9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites | | | | ------------------------- | ------------------------------------------------------------------- | @@ -4441,7 +6345,15 @@ for instructions on how to enable interntionalization for your site. **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -###### 9.2.1.2.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site` +
+
+ +
+ + 9.2.1.2.12. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site + + +
| | | | ------------ | -------- | @@ -4450,7 +6362,15 @@ for instructions on how to enable interntionalization for your site. **Description:** The site to deploy -###### 9.2.1.2.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source` +
+
+ +
+ + 9.2.1.2.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source + + +
| | | | ------------ | -------- | @@ -4459,7 +6379,15 @@ for instructions on how to enable interntionalization for your site. **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -###### 9.2.1.2.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target` +
+
+ +
+ + 9.2.1.2.14. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target + + +
| | | | ------------ | -------- | @@ -4469,14 +6397,41 @@ for instructions on how to enable interntionalization for your site. **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -###### 9.2.1.2.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash` +
+
+ +
+ + 9.2.1.2.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash + + +
| | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -## 10. Property `root > remoteconfig` +
+
+ +
+ +
+ +
+ +
+ +
+
+ +
+ + 10. [Optional] Property root > remoteconfig + + +
| | | | ------------------------- | -------------------------------- | @@ -4487,13 +6442,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Remote Config template(s) used by this project. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | -| - [postdeploy](#remoteconfig_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#remoteconfig_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| + [template](#remoteconfig_template ) | No | string | No | - | A path to a CJSON file containing a Remote Config template. | +
+ + 10.1. [Optional] Property root > remoteconfig > postdeploy -### 10.1. Property `root > remoteconfig > postdeploy` + +
| | | | ------------------------- | ---------------- | @@ -4503,11 +6457,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ------------------------------------------- | | [item 0](#remoteconfig_postdeploy_anyOf_i0) | | [item 1](#remoteconfig_postdeploy_anyOf_i1) | +
+ #### 10.1.1. Property `root > remoteconfig > postdeploy > anyOf > item 0` | | | @@ -4527,13 +6485,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------- | ----------- | | [item 0 items](#remoteconfig_postdeploy_anyOf_i0_items) | - | -##### 10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items +##### 10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ #### 10.1.2. Property `root > remoteconfig > postdeploy > anyOf > item 1` | | | @@ -4541,7 +6502,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -### 10.2. Property `root > remoteconfig > predeploy` +
+ +
+ +
+
+ +
+ + 10.2. [Optional] Property root > remoteconfig > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -4551,11 +6524,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ------------------------------------------ | | [item 0](#remoteconfig_predeploy_anyOf_i0) | | [item 1](#remoteconfig_predeploy_anyOf_i1) | +
+ #### 10.2.1. Property `root > remoteconfig > predeploy > anyOf > item 0` | | | @@ -4575,13 +6552,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------ | ----------- | | [item 0 items](#remoteconfig_predeploy_anyOf_i0_items) | - | -##### 10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items +##### 10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ #### 10.2.2. Property `root > remoteconfig > predeploy > anyOf > item 1` | | | @@ -4589,7 +6569,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -### 10.3. Property `root > remoteconfig > template` +
+ +
+ +
+
+ +
+ + 10.3. [Required] Property root > remoteconfig > template + + +
| | | | ------------ | -------- | @@ -4598,7 +6590,18 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A path to a CJSON file containing a Remote Config template. -## 11. Property `root > storage` +
+
+ +
+
+ +
+ + 11. [Optional] Property root > storage + + +
| | | | ------------------------- | ---------------- | @@ -4608,11 +6611,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Firebase Storage rules that should be deployed or emulated. +
+ | Any of(Option) | | ---------------------------------- | | [StorageSingle](#storage_anyOf_i0) | | [item 1](#storage_anyOf_i1) | +
+ ### 11.1. Property `root > storage > anyOf > StorageSingle` | | | @@ -4624,14 +6631,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Deployment options for a single Firebase storage bucket. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| - [postdeploy](#storage_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#storage_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| + [rules](#storage_anyOf_i0_rules ) | No | string | No | - | Path to the rules files for this Firebase Storage bucket. | -| - [target](#storage_anyOf_i0_target ) | No | string | No | - | The deploy target to these Storage rules to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +
+ + 11.1.1. [Optional] Property root > storage > anyOf > item 0 > postdeploy -#### 11.1.1. Property `root > storage > anyOf > item 0 > postdeploy` + +
| | | | ------------------------- | ---------------- | @@ -4641,11 +6646,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ----------------------------------------------- | | [item 0](#storage_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#storage_anyOf_i0_postdeploy_anyOf_i1) | +
+ ##### 11.1.1.1. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -4665,13 +6674,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ----------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 11.1.1.2. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -4679,7 +6691,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -#### 11.1.2. Property `root > storage > anyOf > item 0 > predeploy` +
+ +
+ +
+
+ +
+ + 11.1.2. [Optional] Property root > storage > anyOf > item 0 > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -4689,11 +6713,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ---------------------------------------------- | | [item 0](#storage_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#storage_anyOf_i0_predeploy_anyOf_i1) | +
+ ##### 11.1.2.1. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -4713,13 +6741,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ##### 11.1.2.2. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -4727,7 +6758,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -#### 11.1.3. Property `root > storage > anyOf > item 0 > rules` +
+ +
+ +
+
+ +
+ + 11.1.3. [Required] Property root > storage > anyOf > item 0 > rules + + +
| | | | ------------ | -------- | @@ -4736,7 +6779,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the rules files for this Firebase Storage bucket. -#### 11.1.4. Property `root > storage > anyOf > item 0 > target` +
+
+ +
+ + 11.1.4. [Optional] Property root > storage > anyOf > item 0 > target + + +
| | | | ------------ | -------- | @@ -4746,6 +6797,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target to these Storage rules to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. +
+
+ +
+
+ ### 11.2. Property `root > storage > anyOf > item 1` | | | @@ -4767,7 +6824,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------- | ----------- | | [item 1 items](#storage_anyOf_i1_items) | - | -#### 11.2.1. root > storage > anyOf > item 1 > item 1 items +#### 11.2.1. root > storage > anyOf > item 1 > item 1 items | | | | ------------------------- | ----------- | @@ -4775,15 +6832,12 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| + [bucket](#storage_anyOf_i1_items_bucket ) | No | string | No | - | The Firebase Storage bucket that this config is for. | -| - [postdeploy](#storage_anyOf_i1_items_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | -| - [predeploy](#storage_anyOf_i1_items_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | -| + [rules](#storage_anyOf_i1_items_rules ) | No | string | No | - | Path to the rules files for this Firebase Storage bucket. | -| - [target](#storage_anyOf_i1_items_target ) | No | string | No | - | The deploy target to these Storage rules to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +
+ + 11.2.1.1. [Required] Property root > storage > anyOf > item 1 > item 1 items > bucket -##### 11.2.1.1. Property `root > storage > anyOf > item 1 > item 1 items > bucket` + +
| | | | ------------ | -------- | @@ -4792,7 +6846,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Firebase Storage bucket that this config is for. -##### 11.2.1.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy` +
+
+ +
+ + 11.2.1.2. [Optional] Property root > storage > anyOf > item 1 > item 1 items > postdeploy + + +
| | | | ------------------------- | ---------------- | @@ -4802,11 +6864,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. +
+ | Any of(Option) | | ----------------------------------------------------- | | [item 0](#storage_anyOf_i1_items_postdeploy_anyOf_i0) | | [item 1](#storage_anyOf_i1_items_postdeploy_anyOf_i1) | +
+ ###### 11.2.1.2.1. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0` | | | @@ -4826,13 +6892,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ----------------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i1_items_postdeploy_anyOf_i0_items) | - | -###### 11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items +###### 11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 11.2.1.2.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 1` | | | @@ -4840,7 +6909,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -##### 11.2.1.3. Property `root > storage > anyOf > item 1 > item 1 items > predeploy` +
+ +
+ +
+
+ +
+ + 11.2.1.3. [Optional] Property root > storage > anyOf > item 1 > item 1 items > predeploy + + +
| | | | ------------------------- | ---------------- | @@ -4850,11 +6931,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. +
+ | Any of(Option) | | ---------------------------------------------------- | | [item 0](#storage_anyOf_i1_items_predeploy_anyOf_i0) | | [item 1](#storage_anyOf_i1_items_predeploy_anyOf_i1) | +
+ ###### 11.2.1.3.1. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0` | | | @@ -4874,13 +6959,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i1_items_predeploy_anyOf_i0_items) | - | -###### 11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items +###### 11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | +
+
+ ###### 11.2.1.3.2. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 1` | | | @@ -4888,7 +6976,19 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -##### 11.2.1.4. Property `root > storage > anyOf > item 1 > item 1 items > rules` +
+ +
+ +
+
+ +
+ + 11.2.1.4. [Required] Property root > storage > anyOf > item 1 > item 1 items > rules + + +
| | | | ------------ | -------- | @@ -4897,7 +6997,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the rules files for this Firebase Storage bucket. -##### 11.2.1.5. Property `root > storage > anyOf > item 1 > item 1 items > target` +
+
+ +
+ + 11.2.1.5. [Optional] Property root > storage > anyOf > item 1 > item 1 items > target + + +
| | | | ------------ | -------- | @@ -4907,5 +7015,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target to these Storage rules to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. +
+
+ +
+ +
+ +
+
+ ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:09:43 -0700 +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file From 79a8f726788f36dc337785d59f1e8b48259fc8df Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Tue, 17 Jun 2025 07:24:33 -0700 Subject: [PATCH 09/10] Testing out HTML --- schema/docs/connector-yaml.html | 1855 ++ schema/docs/dataconnect-yaml.html | 598 + schema/docs/extension-yaml.html | 4354 +++++ schema/docs/firebase-config.html | 26890 ++++++++++++++++++++++++++++ schema/docs/schema_doc.css | 181 + schema/docs/schema_doc.min.js | 1 + schema/firebase-config.json | 15 +- scripts/docs-gen/jsfh-config.yaml | 2 + src/firebaseConfig.ts | 18 +- 9 files changed, 33906 insertions(+), 8 deletions(-) create mode 100644 schema/docs/connector-yaml.html create mode 100644 schema/docs/dataconnect-yaml.html create mode 100644 schema/docs/extension-yaml.html create mode 100644 schema/docs/firebase-config.html create mode 100644 schema/docs/schema_doc.css create mode 100644 schema/docs/schema_doc.min.js create mode 100644 scripts/docs-gen/jsfh-config.yaml diff --git a/schema/docs/connector-yaml.html b/schema/docs/connector-yaml.html new file mode 100644 index 00000000000..be8f92d546f --- /dev/null +++ b/schema/docs/connector-yaml.html @@ -0,0 +1,1855 @@ + + + + + + + + + + + + + + Schema Docs + + + +
Type: object
+

connector.yaml is how you configure a connector for your Firebase Data Connect service.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + connectorId
Type: string
+

The ID of the Firebase Data Connect connector.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + javascriptSdk

+

Configuration for a generated Javascript SDK

+

+ +

+
+ + +
root + + + + generate + + + + javascriptSdk + + + + oneOf + + + + javascriptSdk
Type: object
+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + javascriptSdk + + + + oneOf + + + + item 0 + + + + outputDir
Type: string
+

Path to the directory where generated files should be written to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + javascriptSdk + + + + oneOf + + + + item 0 + + + + package
Type: string
+

The package name to use for the generated code.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + javascriptSdk + + + + oneOf + + + + item 0 + + + + packageJSONDir
Type: string
+

The directory containining the package.json to install the generated package in.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+

Additional Properties of any type are allowed.

+ +
root + + + + generate + + + + javascriptSdk + + + + oneOf + + + + item 0 + + + + additionalProperties
Type: object
+ + + + + + + +
+
+
+
+
+ + +
root + + + + generate + + + + javascriptSdk + + + + oneOf + + + + item 1
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + generate + + + + javascriptSdk + + + + oneOf + + + + item 1 + + + + javascriptSdk
Type: object
+Same definition as generate_javascriptSdk_oneOf_i0 +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + dartSdk

+

Configuration for a generated Dart SDK

+

+ +

+
+ + +
root + + + + generate + + + + dartSdk + + + + oneOf + + + + dartSdk
Type: object
+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + dartSdk + + + + oneOf + + + + item 0 + + + + outputDir
Type: string
+

Path to the directory where generated files should be written to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + dartSdk + + + + oneOf + + + + item 0 + + + + package
Type: string
+

The package name to use for the generated code.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+

Additional Properties of any type are allowed.

+ +
root + + + + generate + + + + dartSdk + + + + oneOf + + + + item 0 + + + + additionalProperties
Type: object
+ + + + + + + +
+
+
+
+
+ + +
root + + + + generate + + + + dartSdk + + + + oneOf + + + + item 1
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + generate + + + + dartSdk + + + + oneOf + + + + item 1 + + + + dartSdk
Type: object
+Same definition as generate_dartSdk_oneOf_i0 +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + kotlinSdk

+

Configuration for a generated Kotlin SDK

+

+ +

+
+ + +
root + + + + generate + + + + kotlinSdk + + + + oneOf + + + + kotlinSdk
Type: object
+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + kotlinSdk + + + + oneOf + + + + item 0 + + + + outputDir
Type: string
+

Path to the directory where generated files should be written to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + kotlinSdk + + + + oneOf + + + + item 0 + + + + package
Type: string
+

The package name to use for the generated code.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+

Additional Properties of any type are allowed.

+ +
root + + + + generate + + + + kotlinSdk + + + + oneOf + + + + item 0 + + + + additionalProperties
Type: object
+ + + + + + + +
+
+
+
+
+ + +
root + + + + generate + + + + kotlinSdk + + + + oneOf + + + + item 1
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + generate + + + + kotlinSdk + + + + oneOf + + + + item 1 + + + + kotlinSdk
Type: object
+Same definition as generate_kotlinSdk_oneOf_i0 +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + swiftSdk

+

Configuration for a generated Swift SDK

+

+ +

+
+ + +
root + + + + generate + + + + swiftSdk + + + + oneOf + + + + swiftSdk
Type: object
+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + swiftSdk + + + + oneOf + + + + item 0 + + + + outputDir
Type: string
+

Path to the directory where generated files should be written to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+

Additional Properties of any type are allowed.

+ +
root + + + + generate + + + + swiftSdk + + + + oneOf + + + + item 0 + + + + additionalProperties
Type: object
+ + + + + + + +
+
+
+
+
+ + +
root + + + + generate + + + + swiftSdk + + + + oneOf + + + + item 1
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + generate + + + + swiftSdk + + + + oneOf + + + + item 1 + + + + swiftSdk
Type: object
+Same definition as generate_swiftSdk_oneOf_i0 +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + llmTools

+

+ +

+
+ + +
root + + + + generate + + + + llmTools + + + + oneOf + + + + llmTools
Type: object
+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + generate + + + + llmTools + + + + oneOf + + + + item 0 + + + + outputFile
Type: string
+

Path where the JSON LLM tool definitions file should be generated.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+

Additional Properties of any type are allowed.

+ +
root + + + + generate + + + + llmTools + + + + oneOf + + + + item 0 + + + + additionalProperties
Type: object
+ + + + + + + +
+
+
+
+
+ + +
root + + + + generate + + + + llmTools + + + + oneOf + + + + item 1
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + generate + + + + llmTools + + + + oneOf + + + + item 1 + + + + llmTools
Type: object
+Same definition as generate_llmTools_oneOf_i0 +
+
+
+ + + + + + +
+
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/schema/docs/dataconnect-yaml.html b/schema/docs/dataconnect-yaml.html new file mode 100644 index 00000000000..9378b827a45 --- /dev/null +++ b/schema/docs/dataconnect-yaml.html @@ -0,0 +1,598 @@ + + + + + + + + + + + + + + Schema Docs + + + +
Type: object
+

dataconnect.yaml is how you configure a Firebase Data Connect service.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + specVersion
Type: string
+

The Firebase Data Connect API version to target. If omitted, defaults to the latest version

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + serviceId
Type: string
+

The ID of the Firebase Data Connect service.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + location
Type: string
+

The region of the Firebase Data Connect service.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + connectorDirs
Type: array of string
+

A list of directories containing conector.yaml files describing a connector to deploy.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + connectorDirs + + + + connectorDirs items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema + + + + source
Type: string
+

Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema + + + + datasource
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema + + + + datasource + + + + postgresql
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema + + + + datasource + + + + postgresql + + + + database
Type: string
+

The name of the PostgreSQL database.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema + + + + datasource + + + + postgresql + + + + cloudSql
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema + + + + datasource + + + + postgresql + + + + cloudSql + + + + instanceId
Type: string
+

The ID of the CloudSQL instance for this database

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + schema + + + + datasource + + + + postgresql + + + + cloudSql + + + + schemaValidation
Type: enum (of string)
+

Schema validation mode for schema migrations

+
+

Must be one of:

+
  • "COMPATIBLE"
  • "STRICT"
+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/schema/docs/extension-yaml.html b/schema/docs/extension-yaml.html new file mode 100644 index 00000000000..0fdf316805a --- /dev/null +++ b/schema/docs/extension-yaml.html @@ -0,0 +1,4354 @@ + + + + + + + + + + + + + + Schema Docs + + + +
Type: object
+

extension.yaml declares the resources and configurable parameters for a Firebase Extension.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + name
Type: string
+

ID of this extension (ie your-extension-name)

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + version
Type: string
+

Version of this extension. Follows https://semver.org/.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + specVersion
Type: string
+

Version of the extension.yaml spec that this file follows. Currently always 'v1beta'

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + license
Type: string
+

The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + displayName
Type: string
+

Human readable name for this extension (ie 'Your Extension Name')

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + description
Type: string
+

A one to two sentence description of what this extension does

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + icon
Type: string
+

The file name of this extension's icon

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + billingRequired
Type: boolean
+

Whether this extension requires a billing to be enabled on the project it is installed on

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + tags
Type: array of string
+

A list of tags to help users find your extension in search

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + tags + + + + tags items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + sourceUrl
Type: string
+

The URL of the GitHub repo hosting this code

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + releaseNotesUrl
Type: string
+

A URL where users can view the full changelog or release notes for this extension

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + author
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + author + + + + authorName
Type: string
+

The author's name

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + author + + + + email
Type: string
+

A contact email for the author

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + author + + + + url
Type: string
+

URL of the author's website

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + contributors
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + contributors + + + + author
Type: object
+Same definition as author +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apis
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + apis + + + + api
Type: object
+

A Google API used by this extension. Will be enabled on extension deployment.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + apis + + + + apis items + + + + apiName
Type: string
+

Name of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library

+Must match regular expression: [^\.]+\.googleapis\.com + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apis + + + + apis items + + + + reason
Type: string
+

Why this extension needs this API enabled

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + roles
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + roles + + + + role
Type: object
+

An IAM role to grant to this extension.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + roles + + + + roles items + + + + role
Type: string
+

Name of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles

+Must match regular expression: [a-zA-Z]+\.[a-zA-Z]+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + roles + + + + roles items + + + + reason
Type: string
+

Why this extension needs this IAM role

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + roles + + + + roles items + + + + resource
Type: string
+

What resource to grant this role on. If omitted, defaults to projects/${project_id}

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + externalServices
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + externalServices + + + + externalService
Type: object
+

A non-Google API used by this extension

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + externalServices + + + + externalServices items + + + + name
Type: string
+

Name of the external service

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + externalServices + + + + externalServices items + + + + pricingUri
Type: string
+

URI to pricing information for the service

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + params + + + + param
Type: object
+

A parameter that users installing this extension can configure

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + param
Type: string
+

The name of the param. This is how you reference the param in your code

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + label
Type: string
+

Short description for the parameter. Displayed to users when they're prompted for the parameter's value.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + description
Type: string
+

Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + example
Type: string
+

Example value for the parameter.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + validationRegex
Type: string
+

Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + validationErrorMessage
Type: string
+

Error message to display if regex validation fails.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + default
Type: string
+

Default value for the parameter if the user leaves the parameter's value blank.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + required
Type: boolean
+

Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + immutable
Type: boolean
+

Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + advanced
Type: boolean
+

Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + type
Type: string
+

The parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details.

+Must match regular expression: string|select|multiSelect|secret|selectResource + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + resourceType
Type: string
+

The type of resource to prompt the user to select. Provides a special UI treatment for the param.

+Must match regular expression: storage\.googleapis\.com\/Bucket|firestore\.googleapis\.com\/Database|firebasedatabase\.googleapis\.com\/DatabaseInstance + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + options
Type: array
+

Options for a select or multiSelect type param.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + params + + + + params items + + + + options + + + + paramOption
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + options + + + + options items + + + + value
Type: string
+

One of the values the user can choose. This is the value you get when you read the parameter value in code.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + params + + + + params items + + + + options + + + + options items + + + + label
Type: string
+

Short description of the selectable option. If omitted, defaults to value.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + resources + + + + resource
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + name
Type: string
+

The name of this resource

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + type
Type: string
+

What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + description
Type: string
+

A brief description of what this resource does

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties
Type: object
+

The properties of this resource

+ + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + location
Type: string
+

The location for this resource

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + entryPoint
Type: string
+

The entry point for a function resource

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + sourceDirectory
Type: string
+

Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + timeout
Type: string
+

A function resources's maximum execution time.

+Must match regular expression: \d+s + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + availableMemoryMb
Type: string
+

Amount of memory in MB available for the function.

+Must match regular expression: \d+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + runtime
Type: string
+

Runtime environment for the function. Defaults to the most recent LTS version of node.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + httpsTrigger
Type: object
+

A function triggered by HTTPS calls

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger
Type: object
+

A function triggered by a background event

+ + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + eventType
Type: string
+

The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + resource
Type: string
+

The name or pattern of the resource to trigger on

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + eventFilters
Type: array
+

Filters that further limit the events to listen to.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + eventFilters + + + + eventFilter
Type: object
+ + + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + eventFilters + + + + eventFilters items + + + + attribute
Type: string
+

The event attribute to filter on

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + eventFilters + + + + eventFilters items + + + + value
Type: string
+

The value to filter for

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + channel
Type: string
+

The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + eventTrigger + + + + triggerRegion
Type: string
+

The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + scheduleTrigger
Type: object
+

A function triggered at a regular interval by a Cloud Scheduler job

+ + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + scheduleTrigger + + + + schedule
Type: string
+

The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#definingthecronjobschedule) syntax.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + scheduleTrigger + + + + timeZone
Type: string
+

The time zone in which the schedule will run. Defaults to UTC.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + taskQueueTrigger
Type: object
+

A function triggered by a Cloud Task

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + buildConfig
Type: object
+

Build configuration for a gen 2 Cloud Function

+ + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + buildConfig + + + + runtime
Type: string
+

Runtime environment for the function. Defaults to the most recent LTS version of node.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + buildConfig + + + + entryPoint
Type: string
+

The entry point for a function resource

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + serviceConfig
Type: object
+

Service configuration for a gen 2 Cloud Function

+ + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + serviceConfig + + + + timeoutSeconds
Type: string
+

The function's maximum execution time. Default: 60, max value: 540.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + resources + + + + resources items + + + + properties + + + + serviceConfig + + + + availableMemory
Type: string
+

The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+

Additional Properties of any type are allowed.

+ +
root + + + + resources + + + + resources items + + + + properties + + + + additionalProperties
Type: object
+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + lifecycleEvents
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + lifecycleEvents + + + + lifecycleEvent
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + lifecycleEvents + + + + lifecycleEvents items + + + + onInstall
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + lifecycleEvents + + + + lifecycleEvents items + + + + onInstall + + + + function
Type: string
+

Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + lifecycleEvents + + + + lifecycleEvents items + + + + onInstall + + + + processingMessage
Type: string
+

Message to display in the Firebase console while the task is in progress.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + lifecycleEvents + + + + lifecycleEvents items + + + + onUpdate
Type: object
+Same definition as onInstall +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + lifecycleEvents + + + + lifecycleEvents items + + + + onConfigure
Type: object
+Same definition as onInstall +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + events
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + events + + + + event
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + events + + + + events items + + + + type
Type: string
+

The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + events + + + + events items + + + + description
Type: string
+

A description of the event

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/schema/docs/firebase-config.html b/schema/docs/firebase-config.html new file mode 100644 index 00000000000..a4bf7e5ac19 --- /dev/null +++ b/schema/docs/firebase-config.html @@ -0,0 +1,26890 @@ + + + + + + + + + + + + + + Schema Docs + + + +
Type: object
+

Information about the resources in your Firebase project.
+This used for declarative deployments via firebase deploy and local emulation via firebase emulators:start

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + $schema
Type: stringFormat: uri
+

Unused. Included in schema so that the schema can be applied to single files.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting

+

The App Hosting backend(s) that should be deployed or emulated.

+

+ +

+
+ + +
root + + + + apphosting + + + + anyOf + + + + item 0
Type: object
+

A single App Hosting deployment config

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 0 + + + + alwaysDeployFromSource
Type: boolean
+

If true, this backend will only be deployed from local source, not from source control.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 0 + + + + backendId
Type: string
+

The ID of the backend that should be deployed.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 0 + + + + ignore
Type: array of string
+

A list of file paths to exclude from the archive that is uploaded for this backend.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + apphosting + + + + anyOf + + + + item 0 + + + + ignore + + + + ignore items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 0 + + + + rootDir
Type: string
+

The root directory of your app. This directory will be archived and uploaded during dpeloyment.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + apphosting + + + + anyOf + + + + item 1
Type: array of object
+

A list of App Hosting deployment configs

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + apphosting + + + + anyOf + + + + item 1 + + + + item 1 items
Type: object
+

A single App Hosting deployment config

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + alwaysDeployFromSource
Type: boolean
+

If true, this backend will only be deployed from local source, not from source control.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + backendId
Type: string
+

The ID of the backend that should be deployed.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + ignore
Type: array of string
+

A list of file paths to exclude from the archive that is uploaded for this backend.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + apphosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + ignore + + + + ignore items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + apphosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + rootDir
Type: string
+

The root directory of your app. This directory will be archived and uploaded during dpeloyment.

+ + + + + + + +
+
+
+
+
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database

+

The Realtime Database rules that should be deployed or emulated.

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + DatabaseSingle
Type: object
+

Deployment options for a single Realtime Database instance.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + database + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + database + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 0 + + + + rules
Type: string
+

The rules files for this Realtime Database instance.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1
Type: array
+

Deployment options for a list of Realtime Database instancs.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + instance
Type: string
+

The instance that this rules files is for.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + rules
Type: string
+

The rules files for this Realtime Database instance.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + target
Type: string
+ + + + + + + +
+
+
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + instance
Type: string
+

The instance that this rules files is for.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + rules
Type: string
+

The rules files for this Realtime Database instance.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + database + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + target
Type: string
+ + + + + + + +
+
+
+
+
+ + + + + + +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + dataconnect

+

The Data Connect service(s) that should be deployed or emulated.

+

+ +

+
+ + +
root + + + + dataconnect + + + + anyOf + + + + DataConnectSingle
Type: object
+

A single Data Connect deployment configs

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + dataconnect + + + + anyOf + + + + item 0 + + + + source
Type: string
+

The directory containing dataconnect.yaml for this service

+ + + + + + + +
+
+
+
+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 1
Type: array
+

A list of Data Connect deployment configs

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + dataconnect + + + + anyOf + + + + item 1 + + + + DataConnectSingle
Type: object
+

A single Data Connect deployment configs

+Same definition as dataconnect_anyOf_i0 +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators
Type: object
+

Hosts, ports, and configuration options for the Firebase Emulator suite.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + apphosting
Type: object
+

Config for the App Hosting emulator

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + apphosting + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + apphosting + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + apphosting + + + + rootDirectory
Type: string
+

The root directory of your app. The start command will ran from this directory.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + apphosting + + + + startCommand
Type: string
+

The command that will be run to start your app when emulating your App Hosting backend

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + apphosting + + + + startCommandOverride
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + auth
Type: object
+

Config for the Auth emulator

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + auth + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + auth + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + database
Type: object
+

Config for the Realtime Database emulator

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + database + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + database + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + dataconnect
Type: object
+

Config for the Data Connect emulator.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + dataconnect + + + + dataDir
Type: string
+

The directory to persist emulator data to. If set, data will be saved between runs automatically.
+If the --import flag is used, the current data will be overwritten by the imported data.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + dataconnect + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + dataconnect + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + dataconnect + + + + postgresHost
Type: string
+

Host for the Postgres database that backs the Data Connect emulator.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + dataconnect + + + + postgresPort
Type: number
+

Port for the Postgres database that backs the Data Connect emulator.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + eventarc
Type: object
+

Config for the EventArc emulator.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + eventarc + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + eventarc + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + extensions
Type: object
+

Placeholder - the Extensions emulator has no configuration options.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + firestore
Type: object
+

Config for the Firestore emulator

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + firestore + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + firestore + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + firestore + + + + websocketPort
Type: number
+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + hosting
Type: object
+

Config for the Firebase Hosting emulator

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + hosting + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + hosting + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + hub
Type: object
+

Config for the emulator suite hub.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + hub + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + hub + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + logging
Type: object
+

Config for the logging emulator.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + logging + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + logging + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + pubsub
Type: object
+

Config for the Pub/Sub emulator

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + pubsub + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + pubsub + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + singleProjectMode
Type: boolean
+

If true, the Emulator Suite will only allow a single project to be used at a time.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + storage
Type: object
+

Config for the Firebase Storage emulator

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + storage + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + storage + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + tasks
Type: object
+

Config for the Cloud Tasks emulator.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + tasks + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + tasks + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + ui
Type: object
+

Config for the Emulator UI.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + ui + + + + enabled
Type: boolean
+

If false, the Emulator UI will not be served.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + ui + + + + host
Type: string
+

The host that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + emulators + + + + ui + + + + port
Type: number
+

The port that this emulator will serve on.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + extensions
Type: object
+

The Firebase Extension(s) that should be deployed or emulated.

+ + + + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore

+

The Firestore rules and indexes that should be deployed or emulated.

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + FirestoreSingle
Type: object
+

Deployment options for a single Firestore database.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + database
Type: string
+

The id of the Firestore database to deploy. If omitted, defaults to '(default)'

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + indexes
Type: string
+

Path to the firestore indexes file

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + location
Type: string
+

The region of the Firestore database to deploy. Required when 'database' is set.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 0 + + + + rules
Type: string
+

Path to the firestore rules file

+ + + + + + + +
+
+
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1
Type: array
+

Deployment options for a list of Firestore databases.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + database
Type: string
+

The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + indexes
Type: string
+

Path to the firestore indexes file for this database

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + rules
Type: string
+

Path to the firestore rules file for this database

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + target
Type: string
+

The deploy target these rules and indexes should be deployed to.
+See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + database
Type: string
+

The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + indexes
Type: string
+

Path to the firestore indexes file for this database

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + rules
Type: string
+

Path to the firestore rules file for this database

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + firestore + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + target
Type: string
+

The deploy target these rules and indexes should be deployed to.
+See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.

+ + + + + + + +
+
+
+
+
+ + + + + + +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + functions

+

The Cloud Functions for Firebase that should be deployed or emulated.

+

+ +

+
+ + +
root + + + + functions + + + + anyOf + + + + FunctionConfig
Type: object
+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + functions + + + + anyOf + + + + item 0 + + + + codebase
Type: string
+

The codebase that these functions are part of. You can use codebases to control which functions are deployed
+ ie: firebase deploy --only functions:my-codebase

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + functions + + + + anyOf + + + + item 0 + + + + ignore
Type: array of string
+

Files in the source directory that should not be uploaed during dpeloyment.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + functions + + + + anyOf + + + + item 0 + + + + ignore + + + + ignore items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + functions + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + functions + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + functions + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + functions + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + functions + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + functions + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + functions + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + functions + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + functions + + + + anyOf + + + + item 0 + + + + runtime
Type: enum (of string)
+

The runtime these functions should use.

+
+

Must be one of:

+
  • "nodejs20"
  • "nodejs22"
  • "python310"
  • "python311"
  • "python312"
  • "python313"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + functions + + + + anyOf + + + + item 0 + + + + source
Type: string
+

The directory containing your functions source code.
+This directory will be archived and uploaded during deployment.
+Files outside of this directory will not be included and should not be referenced from your functions code.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + functions + + + + anyOf + + + + item 1
Type: array
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + functions + + + + anyOf + + + + item 1 + + + + FunctionConfig
Type: object
+Same definition as functions_anyOf_i0 +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting

+

The Firebase Hosting site(s) that should be deployed or emulated.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + HostingSingle
Type: object
+

Deployment options for a single Firebase Hosting site.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + appAssociation
Type: enum (of string)
+
+

Must be one of:

+
  • "AUTO"
  • "NONE"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + cleanUrls
Type: boolean
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend
Type: object
+

Options for this sites web frameworks backend.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + concurrency
Type: number
+

Number of requests a function can serve at once.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + cors
Type: string or boolean
+
+

If true, allows CORS on requests to this function.
+If this is a string or RegExp, allows requests from domains that match the provided value.
+If this is an Array, allows requests from domains matching at least one entry of the array.
+Defaults to true for {@link https.CallableFunction} and false otherwise.

+ +
+
+ +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + cpu

+

Fractional number of CPUs to allocate to a function.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + cpu + + + + anyOf + + + + item 0
Type: const
+Specific value: "gcf_gen1" + + + + + + +
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + cpu + + + + anyOf + + + + item 1
Type: number
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + enforceAppCheck
Type: boolean
+

Determines whether Firebase AppCheck is enforced. Defaults to false.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + ingressSettings
Type: enum (of string)
+

Ingress settings which control where this function can be called from.

+
+

Must be one of:

+
  • "ALLOW_ALL"
  • "ALLOW_INTERNAL_AND_GCLB"
  • "ALLOW_INTERNAL_ONLY"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + invoker
Type: const
+

Invoker to set access control on https functions.

+Specific value: "public" + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + labels
Type: object
+

User labels to set on the function.

+ + + + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + maxInstances
Type: number
+

Max number of instances to be running in parallel.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + memory
Type: enum (of string)
+

Amount of memory to allocate to a function.

+
+

Must be one of:

+
  • "128MiB"
  • "16GiB"
  • "1GiB"
  • "256MiB"
  • "2GiB"
  • "32GiB"
  • "4GiB"
  • "512MiB"
  • "8GiB"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + minInstances
Type: number
+

Min number of actual instances to be running at a given time.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + omit
Type: boolean
+

If true, do not deploy or emulate this function.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + preserveExternalChanges
Type: boolean
+

Controls whether function configuration modified outside of function source is preserved. Defaults to false.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + region
Type: string
+

HTTP functions can override global options and can specify multiple regions to deploy to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + secrets
Type: array of string
+

A list of secrets used in this app.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + secrets + + + + secrets items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + serviceAccount
Type: string
+

Specific service account for the function to run as.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + timeoutSeconds
Type: number
+

Timeout for the function in seconds, possible values are 0 to 540.
+HTTPS functions can specify a higher timeout.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + vpcConnector
Type: string
+

Connect cloud function to specified VPC connector.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + frameworksBackend + + + + vpcConnectorEgressSettings
Type: enum (of string)
+

Egress settings for VPC connector.

+
+

Must be one of:

+
  • "ALL_TRAFFIC"
  • "PRIVATE_RANGES_ONLY"
+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers
Type: array
+

A list of extra headers to send when serving specific paths on this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + HostingHeaders
Type: object
+

Extra headers that should be sent when serving this path.

+ + +

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 0
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 0 + + + + glob
Type: string
+

A glob pattern describing the paths that this setting should apply to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 0 + + + + headers
Type: array of object
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 0 + + + + headers + + + + headers items
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + key
Type: string
+

The header to set.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + value
Type: string
+

The value to set this header to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 1
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 1 + + + + headers
Type: array of object
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 1 + + + + headers + + + + headers items
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 1 + + + + headers + + + + headers items + + + + key
Type: string
+

The header to set.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 1 + + + + headers + + + + headers items + + + + value
Type: string
+

The value to set this header to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 1 + + + + source
Type: string
+

A file path that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 2
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 2 + + + + headers
Type: array of object
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 2 + + + + headers + + + + headers items
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 2 + + + + headers + + + + headers items + + + + key
Type: string
+

The header to set.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 2 + + + + headers + + + + headers items + + + + value
Type: string
+

The value to set this header to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + headers + + + + headers items + + + + anyOf + + + + item 2 + + + + regex
Type: string
+

A regex pattern that matches the paths that this setting should apply to. *

+ + + + + + + +
+
+
+
+
+ + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + i18n
Type: object
+

Internationalization config for this site.
+See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
+for instructions on how to enable interntionalization for your site.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + i18n + + + + root
Type: string
+

The directory containing internationalization rewrites.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + ignore
Type: array of string
+

A list of paths or globs within the source directory that should not be included in the uploaded archive.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + ignore + + + + ignore items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + public
Type: string
+

Whether this site should publically available.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects
Type: array
+

A list of redirects for this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + HostingRedirects
Type: object
+

URL redirects for a hosting site. Use these to prevent broken links when moving pages.

+ + +

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 0
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 0 + + + + destination
Type: string
+

The destination to redirect to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 0 + + + + glob
Type: string
+

A glob pattern describing the paths that this setting should apply to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 0 + + + + type
Type: enum (of integer)
+

The type of redirect.
+Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)

+
+

Must be one of:

+
  • 301
  • 302
+
+ + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 1
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 1 + + + + destination
Type: string
+

The destination to redirect to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 1 + + + + source
Type: string
+

A file path that this setting should apply to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 1 + + + + type
Type: enum (of integer)
+

The type of redirect.
+Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)

+
+

Must be one of:

+
  • 301
  • 302
+
+ + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 2
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 2 + + + + destination
Type: string
+

The destination to redirect to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 2 + + + + regex
Type: string
+

A regex pattern that matches the paths that this setting should apply to. *

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + redirects + + + + redirects items + + + + anyOf + + + + item 2 + + + + type
Type: enum (of integer)
+

The type of redirect.
+Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect)

+
+

Must be one of:

+
  • 301
  • 302
+
+ + + + + + +
+
+
+
+
+ + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites
Type: array
+

A list o rewrites for this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + HostingRewrites
Type: object
+

Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service.

+ + +

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 0
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 0 + + + + destination
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 0 + + + + glob
Type: string
+

A glob pattern describing the paths that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 1
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 1 + + + + function
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 1 + + + + glob
Type: string
+

A glob pattern describing the paths that this setting should apply to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 1 + + + + region
Type: string
+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 2
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 2 + + + + function
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 2 + + + + function + + + + functionId
Type: string
+

The ID of the Cloud Function to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 2 + + + + function + + + + pinTag
Type: boolean
+

If true, the rewrite will be pinned to the currently running version of the Cloud Function.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 2 + + + + function + + + + region
Type: string
+

The region of the Cloud Function to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 2 + + + + glob
Type: string
+

A glob pattern describing the paths that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 3
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 3 + + + + glob
Type: string
+

A glob pattern describing the paths that this setting should apply to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 3 + + + + run
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 3 + + + + run + + + + pinTag
Type: boolean
+

If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 3 + + + + run + + + + region
Type: string
+

The region of the Cloud Run service to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 3 + + + + run + + + + serviceId
Type: string
+

The ID of the Cloud Run service to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 4
Type: object
+ No Additional Properties + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 4 + + + + glob
Type: string
+

A glob pattern describing the paths that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 5
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 5 + + + + destination
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 5 + + + + source
Type: string
+

A file path that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 6
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 6 + + + + function
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 6 + + + + region
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 6 + + + + source
Type: string
+

A file path that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 7
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 7 + + + + function
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 7 + + + + function + + + + functionId
Type: string
+

The ID of the Cloud Function to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 7 + + + + function + + + + pinTag
Type: boolean
+

If true, the rewrite will be pinned to the currently running version of the Cloud Function.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 7 + + + + function + + + + region
Type: string
+

The region of the Cloud Function to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 7 + + + + source
Type: string
+

A file path that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 8
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 8 + + + + run
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 8 + + + + run + + + + pinTag
Type: boolean
+

If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 8 + + + + run + + + + region
Type: string
+

The region of the Cloud Run service to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 8 + + + + run + + + + serviceId
Type: string
+

The ID of the Cloud Run service to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 8 + + + + source
Type: string
+

A file path that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 9
Type: object
+ No Additional Properties + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 9 + + + + source
Type: string
+

A file path that this setting should apply to.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 10
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 10 + + + + destination
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 10 + + + + regex
Type: string
+

A regex pattern that matches the paths that this setting should apply to. *

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 11
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 11 + + + + function
Type: string
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 11 + + + + regex
Type: string
+

A regex pattern that matches the paths that this setting should apply to. *

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 11 + + + + region
Type: string
+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 12
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 12 + + + + function
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 12 + + + + function + + + + functionId
Type: string
+

The ID of the Cloud Function to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 12 + + + + function + + + + pinTag
Type: boolean
+

If true, the rewrite will be pinned to the currently running version of the Cloud Function.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 12 + + + + function + + + + region
Type: string
+

The region of the Cloud Function to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 12 + + + + regex
Type: string
+

A regex pattern that matches the paths that this setting should apply to. *

+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 13
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 13 + + + + regex
Type: string
+

A regex pattern that matches the paths that this setting should apply to. *

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 13 + + + + run
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 13 + + + + run + + + + pinTag
Type: boolean
+

If true, the rewrite will be pinned to the currently running revision of the Cloud Run service.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 13 + + + + run + + + + region
Type: string
+

The region of the Cloud Run service to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 13 + + + + run + + + + serviceId
Type: string
+

The ID of the Cloud Run service to rewrite to.

+ + + + + + + +
+
+
+
+
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 14
Type: object
+ No Additional Properties + + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + rewrites + + + + rewrites items + + + + anyOf + + + + item 14 + + + + regex
Type: string
+

A regex pattern that matches the paths that this setting should apply to. *

+ + + + + + + +
+
+
+
+
+ + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + site
Type: string
+

The site to deploy.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + source
Type: string
+

Path to the directory containing this site's source code. This will be archived and uploaded during deployment.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + target
Type: string
+

The deploy target to deploy.
+See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 0 + + + + trailingSlash
Type: boolean
+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1
Type: array
+

Deployment options for a list of Firebase Hosting sites.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + appAssociation
Type: enum (of string)
+
+

Must be one of:

+
  • "AUTO"
  • "NONE"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + cleanUrls
Type: boolean
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + frameworksBackend
Type: object
+

Options for this sites web frameworks backend.

+Same definition as frameworksBackend +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + headers
Type: array
+

A list of extra headers to send when serving specific paths on this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + headers + + + + HostingHeaders
Type: object
+

Extra headers that should be sent when serving this path.

+Same definition as hosting_anyOf_i0_headers_items +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + i18n
Type: object
+

Internationalization config for this site.
+See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
+for instructions on how to enable interntionalization for your site.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + i18n + + + + root
Type: string
+

The directory containing internationalization rewrites.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + ignore
Type: array of string
+

A list of paths or globs within the source directory that should not be included in the uploaded archive.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + ignore + + + + ignore items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + public
Type: string
+

Whether this site should publically available.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + redirects
Type: array
+

A list of redirects for this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + redirects + + + + HostingRedirects
Type: object
+

URL redirects for a hosting site. Use these to prevent broken links when moving pages.

+Same definition as hosting_anyOf_i0_redirects_items +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + rewrites
Type: array
+

A list o rewrites for this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + rewrites + + + + HostingRewrites
Type: object
+

Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service.

+Same definition as hosting_anyOf_i0_rewrites_items +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + site
Type: string
+

The site to deploy

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + source
Type: string
+

Path to the directory containing this site's source code. This will be archived and uploaded during deployment.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + target
Type: string
+

The deploy target to deploy.
+See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 0 + + + + trailingSlash
Type: boolean
+ + + + + + + +
+
+
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + appAssociation
Type: enum (of string)
+
+

Must be one of:

+
  • "AUTO"
  • "NONE"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + cleanUrls
Type: boolean
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + frameworksBackend
Type: object
+

Options for this sites web frameworks backend.

+Same definition as frameworksBackend +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + headers
Type: array
+

A list of extra headers to send when serving specific paths on this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + headers + + + + HostingHeaders
Type: object
+

Extra headers that should be sent when serving this path.

+Same definition as hosting_anyOf_i0_headers_items +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + i18n
Type: object
+

Internationalization config for this site.
+See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
+for instructions on how to enable interntionalization for your site.

+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + i18n + + + + root
Type: string
+

The directory containing internationalization rewrites.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + ignore
Type: array of string
+

A list of paths or globs within the source directory that should not be included in the uploaded archive.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + ignore + + + + ignore items
Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + public
Type: string
+

Whether this site should publically available.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + redirects
Type: array
+

A list of redirects for this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + redirects + + + + HostingRedirects
Type: object
+

URL redirects for a hosting site. Use these to prevent broken links when moving pages.

+Same definition as hosting_anyOf_i0_redirects_items +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + rewrites
Type: array
+

A list o rewrites for this site.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + rewrites + + + + HostingRewrites
Type: object
+

Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service.

+Same definition as hosting_anyOf_i0_rewrites_items +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + site
Type: string
+

The site to deploy

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + source
Type: string
+

Path to the directory containing this site's source code. This will be archived and uploaded during deployment.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + target
Type: string
+

The deploy target to deploy.
+See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + hosting + + + + anyOf + + + + item 1 + + + + item 1 items + + + + anyOf + + + + item 1 + + + + trailingSlash
Type: boolean
+ + + + + + + +
+
+
+
+
+ + + + + + +
+
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + remoteconfig
Type: object
+

The Remote Config template(s) used by this project.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + remoteconfig + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + remoteconfig + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + remoteconfig + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + remoteconfig + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + remoteconfig + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + remoteconfig + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + remoteconfig + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + remoteconfig + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + remoteconfig + + + + template
Type: string
+

A path to a CJSON file containing a Remote Config template.

+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage

+

The Firebase Storage rules that should be deployed or emulated.

+

+ +

+
+ + +
root + + + + storage + + + + anyOf + + + + StorageSingle
Type: object
+

Deployment options for a single Firebase storage bucket.

+ + + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 0 + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + storage + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 0 + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 0 + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + storage + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 0 + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 0 + + + + rules
Type: string
+

Path to the rules files for this Firebase Storage bucket.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 0 + + + + target
Type: string
+

The deploy target to these Storage rules to.
+See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.

+ + + + + + + +
+
+
+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 1
Type: array of object
+

Deployment options for multiple Firebase storage buckets.

+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items
Type: object
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + bucket
Type: string
+

The Firebase Storage bucket that this config is for.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + postdeploy

+

A script or list of scripts that will be ran after this product is deployed.

+

+ +

+
+ + +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + postdeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + postdeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + postdeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + predeploy

+

A script or list of scripts that will be ran before this product is deployed.

+

+ +

+
+ + +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + predeploy + + + + anyOf + + + + item 0
Type: array of string
+ + + + + + + No Additional Items

Each item of this array must be:

+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + predeploy + + + + anyOf + + + + item 0 + + + + item 0 items
Type: string
+ + + + + + + +
+
+
+ + +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + predeploy + + + + anyOf + + + + item 1
Type: string
+ + + + + + + +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + rules
Type: string
+

Path to the rules files for this Firebase Storage bucket.

+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +
root + + + + storage + + + + anyOf + + + + item 1 + + + + item 1 items + + + + target
Type: string
+

The deploy target to these Storage rules to.
+See https://firebase.google.com/docs/cli/targets to learn more about deploy targets.

+ + + + + + + +
+
+
+
+
+
+
+ + + + + + +
+
+
+
+ + + \ No newline at end of file diff --git a/schema/docs/schema_doc.css b/schema/docs/schema_doc.css new file mode 100644 index 00000000000..e1f3a5112e3 --- /dev/null +++ b/schema/docs/schema_doc.css @@ -0,0 +1,181 @@ +body { + font: 16px/1.5em "Overpass", "Open Sans", Helvetica, sans-serif; + color: #333; + font-weight: 300; + padding: 40px; +} + +.btn.btn-link { + font-size: 18px; + user-select: text; +} + +.jsfh-animated-property { + animation: eclair; + animation-iteration-count: 1; + animation-fill-mode: forwards; + animation-duration: .75s; + +} + +@keyframes eclair { + 0%,100% { + transform: scale(1); + } + 50% { + transform: scale(1.03); + } +} + +.btn.btn-primary { + margin: 10px; +} + +.btn.example-show.collapsed:before { + content: "show" +} + +.btn.example-show:before { + content: "hide" +} + +.description.collapse:not(.show) { + max-height: 100px !important; + overflow: hidden; + + display: -webkit-box; + -webkit-line-clamp: 2; + -webkit-box-orient: vertical; +} + +.description.collapsing { + min-height: 100px !important; +} + +.collapse-description-link.collapsed:after { + content: '+ Read More'; +} + +.collapse-description-link:not(.collapsed):after { + content: '- Read Less'; +} + +.badge { + font-size: 100%; + margin-bottom: 0.5rem; + margin-top: 0.5rem; +} + +.badge.value-type { + font-size: 120%; + margin-right: 5px; + margin-bottom: 10px; +} + + +.badge.default-value { + font-size: 120%; + margin-left: 5px; + margin-bottom: 10px; +} + +.badge.restriction { + display: inline-block; +} + +.badge.required-property,.badge.deprecated-property,.badge.pattern-property,.badge.no-additional { + font-size: 100%; + margin-left: 10px; +} + +.accordion div.card:only-child { + border-bottom: 1px solid rgba(0, 0, 0, 0.125); +} + +.examples { + padding: 1rem !important; +} + +.examples pre { + margin-bottom: 0; +} + +.highlight.jumbotron { + padding: 1rem !important; +} + +.generated-by-footer { + margin-top: 1em; + text-align: right; +} + +/* From https://github.com/richleland/pygments-css/blob/master/friendly.css, see https://github.com/trentm/python-markdown2/wiki/fenced-code-blocks */ +.highlight { background: #e9ecef; } /* Changed from #f0f0f0 in the original style to be the same as bootstrap's jumbotron */ +.highlight .hll { background-color: #ffffcc } +.highlight .c { color: #60a0b0; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #40a070 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #40a070 } /* Literal.Number.Bin */ +.highlight .mf { color: #40a070 } /* Literal.Number.Float */ +.highlight .mh { color: #40a070 } /* Literal.Number.Hex */ +.highlight .mi { color: #40a070 } /* Literal.Number.Integer */ +.highlight .mo { color: #40a070 } /* Literal.Number.Oct */ +.highlight .sa { color: #4070a0 } /* Literal.String.Affix */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #06287e } /* Name.Function.Magic */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ +.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */ diff --git a/schema/docs/schema_doc.min.js b/schema/docs/schema_doc.min.js new file mode 100644 index 00000000000..17eceaf59a3 --- /dev/null +++ b/schema/docs/schema_doc.min.js @@ -0,0 +1 @@ +$(document).on("click",'a[href^="#"]',function(event){event.preventDefault();history.pushState({},"",this.href)});function flashElement(elementId){myElement=document.getElementById(elementId);myElement.classList.add("jsfh-animated-property");setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(anchorLinkDestination){history.pushState({},"",anchorLinkDestination)}function anchorOnLoad(){let linkTarget=decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);if(linkTarget[0]==="#"){linkTarget=linkTarget.substr(1)}if(linkTarget.length>0){anchorLink(linkTarget)}}function anchorLink(linkTarget){const target=$("#"+linkTarget);target.parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(index){if($(this).hasClass("collapse")){$(this).collapse("show")}else if($(this).hasClass("tab-pane")){const tabToShow=$("a[href='#"+$(this).attr("id")+"']");if(tabToShow){tabToShow.tab("show")}}else if($(this).attr("role")==="tab"){$(this).tab("show")}});setTimeout(function(){let targetElement=document.getElementById(linkTarget);if(targetElement){targetElement.scrollIntoView({block:"center",behavior:"smooth"});setTimeout(function(){flashElement(linkTarget)},500)}},1e3)} \ No newline at end of file diff --git a/schema/firebase-config.json b/schema/firebase-config.json index 6bf07b098c0..1251eda023d 100644 --- a/schema/firebase-config.json +++ b/schema/firebase-config.json @@ -35,6 +35,7 @@ "description": "A script or list of scripts that will be ran before this product is deployed." }, "source": { + "description": "The directory containing dataconnect.yaml for this service", "type": "string" } }, @@ -562,6 +563,7 @@ "type": "boolean" }, "region": { + "description": "The region of the Cloud Function to rewrite to.", "type": "string" } }, @@ -596,6 +598,7 @@ "type": "boolean" }, "region": { + "description": "The region of the Cloud Run service to rewrite to.", "type": "string" }, "serviceId": { @@ -684,6 +687,7 @@ "type": "boolean" }, "region": { + "description": "The region of the Cloud Function to rewrite to.", "type": "string" } }, @@ -714,6 +718,7 @@ "type": "boolean" }, "region": { + "description": "The region of the Cloud Run service to rewrite to.", "type": "string" }, "serviceId": { @@ -806,6 +811,7 @@ "type": "boolean" }, "region": { + "description": "The region of the Cloud Function to rewrite to.", "type": "string" } }, @@ -840,6 +846,7 @@ "type": "boolean" }, "region": { + "description": "The region of the Cloud Run service to rewrite to.", "type": "string" }, "serviceId": { @@ -1093,13 +1100,14 @@ "anyOf": [ { "additionalProperties": false, - "description": "A single App Hosting deployment configs", + "description": "A single App Hosting deployment config", "properties": { "alwaysDeployFromSource": { "description": "If true, this backend will only be deployed from local source, not from source control.", "type": "boolean" }, "backendId": { + "description": "The ID of the backend that should be deployed.", "type": "string" }, "ignore": { @@ -1110,6 +1118,7 @@ "type": "array" }, "rootDir": { + "description": "The root directory of your app. This directory will be archived and uploaded during dpeloyment.", "type": "string" } }, @@ -1124,13 +1133,14 @@ "description": "A list of App Hosting deployment configs", "items": { "additionalProperties": false, - "description": "A single App Hosting deployment configs", + "description": "A single App Hosting deployment config", "properties": { "alwaysDeployFromSource": { "description": "If true, this backend will only be deployed from local source, not from source control.", "type": "boolean" }, "backendId": { + "description": "The ID of the backend that should be deployed.", "type": "string" }, "ignore": { @@ -1141,6 +1151,7 @@ "type": "array" }, "rootDir": { + "description": "The root directory of your app. This directory will be archived and uploaded during dpeloyment.", "type": "string" } }, diff --git a/scripts/docs-gen/jsfh-config.yaml b/scripts/docs-gen/jsfh-config.yaml new file mode 100644 index 00000000000..a9552b42913 --- /dev/null +++ b/scripts/docs-gen/jsfh-config.yaml @@ -0,0 +1,2 @@ +template_name: js +show_toc: false \ No newline at end of file diff --git a/src/firebaseConfig.ts b/src/firebaseConfig.ts index ab39bcf1e28..4fd534dfd00 100644 --- a/src/firebaseConfig.ts +++ b/src/firebaseConfig.ts @@ -153,7 +153,7 @@ export type FunctionsRewrite = { function: { /** The ID of the Cloud Function to rewrite to. */ functionId: string; - //* * The region of the Cloud Function to rewrite to. */ + /** The region of the Cloud Function to rewrite to. */ region?: string; /** * If true, the rewrite will be pinned to the currently running version of the Cloud Function. @@ -168,7 +168,7 @@ export type RunRewrite = { run: { /** The ID of the Cloud Run service to rewrite to. */ serviceId: string; - //* * The region of the Cloud Run service to rewrite to. */ + /** The region of the Cloud Run service to rewrite to. */ region?: string; /** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. */ pinTag?: boolean; @@ -522,7 +522,9 @@ export type ExtensionsConfig = Record; * A single Data Connect deployment configs */ export type DataConnectSingle = { - // The directory containing dataconnect.yaml for this service + /** + * The directory containing dataconnect.yaml for this service + */ source: string; } & Deployable; @@ -537,12 +539,16 @@ export type DataConnectMultiple = DataConnectSingle[]; export type DataConnectConfig = DataConnectSingle | DataConnectMultiple; /** - * A single App Hosting deployment configs + * A single App Hosting deployment config */ export type AppHostingSingle = { - // The ID of the backend that should be deployed. + /** + * The ID of the backend that should be deployed. + */ backendId: string; - // The root directory of your app. This directory will be archived and uploaded during dpeloyment. + /** + * The root directory of your app. This directory will be archived and uploaded during dpeloyment. + */ rootDir: string; /** * A list of file paths to exclude from the archive that is uploaded for this backend. From 7ecf47d564bfde843308e5e0a5366790c4227538 Mon Sep 17 00:00:00 2001 From: Joe Hanley Date: Tue, 17 Jun 2025 07:39:26 -0700 Subject: [PATCH 10/10] MD? --- schema/docs/connector-yaml.md | 255 +-- schema/docs/dataconnect-yaml.md | 141 +- schema/docs/extension-yaml.md | 939 ++------ schema/docs/firebase-config.md | 3546 ++++++----------------------- schema/docs/index.md | 11 + scripts/docs-gen/jsfh-config.yaml | 2 +- 6 files changed, 1042 insertions(+), 3852 deletions(-) create mode 100644 schema/docs/index.md diff --git a/schema/docs/connector-yaml.md b/schema/docs/connector-yaml.md index 61ca18cfaca..090d03dad1b 100644 --- a/schema/docs/connector-yaml.md +++ b/schema/docs/connector-yaml.md @@ -8,12 +8,12 @@ **Description:** connector.yaml is how you configure a connector for your Firebase Data Connect service. -
- - 1. [Optional] Property root > connectorId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------ | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| - [connectorId](#connectorId ) | No | string | No | - | The ID of the Firebase Data Connect connector. | +| - [generate](#generate ) | No | object | No | - | - | - -
+## 1. Property `root > connectorId` | | | | ------------ | -------- | @@ -22,15 +22,7 @@ **Description:** The ID of the Firebase Data Connect connector. -
-
- -
- - 2. [Optional] Property root > generate - - -
+## 2. Property `root > generate` | | | | ------------------------- | ----------- | @@ -38,12 +30,15 @@ | **Required** | No | | **Additional properties** | Not allowed | -
- - 2.1. [Optional] Property root > generate > javascriptSdk +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------- | +| - [javascriptSdk](#generate_javascriptSdk ) | No | Combination | No | - | Configuration for a generated Javascript SDK | +| - [dartSdk](#generate_dartSdk ) | No | Combination | No | - | Configuration for a generated Dart SDK | +| - [kotlinSdk](#generate_kotlinSdk ) | No | Combination | No | - | Configuration for a generated Kotlin SDK | +| - [swiftSdk](#generate_swiftSdk ) | No | Combination | No | - | Configuration for a generated Swift SDK | +| - [llmTools](#generate_llmTools ) | No | Combination | No | - | - | - -
+### 2.1. Property `root > generate > javascriptSdk` | | | | ------------------------- | ---------------- | @@ -53,15 +48,11 @@ **Description:** Configuration for a generated Javascript SDK -
- | One of(Option) | | ------------------------------------------------- | | [javascriptSdk](#generate_javascriptSdk_oneOf_i0) | | [item 1](#generate_javascriptSdk_oneOf_i1) | -
- #### 2.1.1. Property `root > generate > javascriptSdk > oneOf > javascriptSdk` | | | @@ -71,12 +62,14 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/javascriptSdk | -
- - 2.1.1.1. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------- | +| - [outputDir](#generate_javascriptSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [package](#generate_javascriptSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | +| - [packageJSONDir](#generate_javascriptSdk_oneOf_i0_packageJSONDir ) | No | string | No | - | The directory containining the package.json to install the generated package in. | +| - [](#generate_javascriptSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.1.1.1. Property `root > generate > javascriptSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -85,15 +78,7 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
- - 2.1.1.2. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > package - - -
+##### 2.1.1.2. Property `root > generate > javascriptSdk > oneOf > item 0 > package` | | | | ------------ | -------- | @@ -102,15 +87,7 @@ **Description:** The package name to use for the generated code. -
-
- -
- - 2.1.1.3. [Optional] Property root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir - - -
+##### 2.1.1.3. Property `root > generate > javascriptSdk > oneOf > item 0 > packageJSONDir` | | | | ------------ | -------- | @@ -119,12 +96,6 @@ **Description:** The directory containining the package.json to install the generated package in. -
-
- -
-
- #### 2.1.2. Property `root > generate > javascriptSdk > oneOf > item 1` | | | @@ -144,7 +115,7 @@ | ------------------------------------------------------- | ----------- | | [javascriptSdk](#generate_javascriptSdk_oneOf_i1_items) | - | -##### 2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk +##### 2.1.2.1. root > generate > javascriptSdk > oneOf > item 1 > javascriptSdk | | | | ------------------------- | ------------------------------------------------------------------- | @@ -153,19 +124,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_javascriptSdk_oneOf_i0](#generate_javascriptSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.2. [Optional] Property root > generate > dartSdk - - -
+### 2.2. Property `root > generate > dartSdk` | | | | ------------------------- | ---------------- | @@ -175,15 +134,11 @@ **Description:** Configuration for a generated Dart SDK -
- | One of(Option) | | ------------------------------------- | | [dartSdk](#generate_dartSdk_oneOf_i0) | | [item 1](#generate_dartSdk_oneOf_i1) | -
- #### 2.2.1. Property `root > generate > dartSdk > oneOf > dartSdk` | | | @@ -193,12 +148,13 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/dartSdk | -
- - 2.2.1.1. [Optional] Property root > generate > dartSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | +| - [outputDir](#generate_dartSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [package](#generate_dartSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | +| - [](#generate_dartSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.2.1.1. Property `root > generate > dartSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -207,15 +163,7 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
- - 2.2.1.2. [Optional] Property root > generate > dartSdk > oneOf > item 0 > package - - -
+##### 2.2.1.2. Property `root > generate > dartSdk > oneOf > item 0 > package` | | | | ------------ | -------- | @@ -224,12 +172,6 @@ **Description:** The package name to use for the generated code. -
-
- -
-
- #### 2.2.2. Property `root > generate > dartSdk > oneOf > item 1` | | | @@ -249,7 +191,7 @@ | ------------------------------------------- | ----------- | | [dartSdk](#generate_dartSdk_oneOf_i1_items) | - | -##### 2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk +##### 2.2.2.1. root > generate > dartSdk > oneOf > item 1 > dartSdk | | | | ------------------------- | ------------------------------------------------------- | @@ -258,19 +200,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_dartSdk_oneOf_i0](#generate_dartSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.3. [Optional] Property root > generate > kotlinSdk - - -
+### 2.3. Property `root > generate > kotlinSdk` | | | | ------------------------- | ---------------- | @@ -280,15 +210,11 @@ **Description:** Configuration for a generated Kotlin SDK -
- | One of(Option) | | ----------------------------------------- | | [kotlinSdk](#generate_kotlinSdk_oneOf_i0) | | [item 1](#generate_kotlinSdk_oneOf_i1) | -
- #### 2.3.1. Property `root > generate > kotlinSdk > oneOf > kotlinSdk` | | | @@ -298,12 +224,13 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/kotlinSdk | -
- - 2.3.1.1. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | +| - [outputDir](#generate_kotlinSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [package](#generate_kotlinSdk_oneOf_i0_package ) | No | string | No | - | The package name to use for the generated code. | +| - [](#generate_kotlinSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.3.1.1. Property `root > generate > kotlinSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -312,15 +239,7 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
- - 2.3.1.2. [Optional] Property root > generate > kotlinSdk > oneOf > item 0 > package - - -
+##### 2.3.1.2. Property `root > generate > kotlinSdk > oneOf > item 0 > package` | | | | ------------ | -------- | @@ -329,12 +248,6 @@ **Description:** The package name to use for the generated code. -
-
- -
-
- #### 2.3.2. Property `root > generate > kotlinSdk > oneOf > item 1` | | | @@ -354,7 +267,7 @@ | ----------------------------------------------- | ----------- | | [kotlinSdk](#generate_kotlinSdk_oneOf_i1_items) | - | -##### 2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk +##### 2.3.2.1. root > generate > kotlinSdk > oneOf > item 1 > kotlinSdk | | | | ------------------------- | ----------------------------------------------------------- | @@ -363,19 +276,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_kotlinSdk_oneOf_i0](#generate_kotlinSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.4. [Optional] Property root > generate > swiftSdk - - -
+### 2.4. Property `root > generate > swiftSdk` | | | | ------------------------- | ---------------- | @@ -385,15 +286,11 @@ **Description:** Configuration for a generated Swift SDK -
- | One of(Option) | | --------------------------------------- | | [swiftSdk](#generate_swiftSdk_oneOf_i0) | | [item 1](#generate_swiftSdk_oneOf_i1) | -
- #### 2.4.1. Property `root > generate > swiftSdk > oneOf > swiftSdk` | | | @@ -403,12 +300,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/swiftSdk | -
- - 2.4.1.1. [Optional] Property root > generate > swiftSdk > oneOf > item 0 > outputDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------- | +| - [outputDir](#generate_swiftSdk_oneOf_i0_outputDir ) | No | string | No | - | Path to the directory where generated files should be written to. | +| - [](#generate_swiftSdk_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.4.1.1. Property `root > generate > swiftSdk > oneOf > item 0 > outputDir` | | | | ------------ | -------- | @@ -417,12 +314,6 @@ **Description:** Path to the directory where generated files should be written to. -
-
- -
-
- #### 2.4.2. Property `root > generate > swiftSdk > oneOf > item 1` | | | @@ -442,7 +333,7 @@ | --------------------------------------------- | ----------- | | [swiftSdk](#generate_swiftSdk_oneOf_i1_items) | - | -##### 2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk +##### 2.4.2.1. root > generate > swiftSdk > oneOf > item 1 > swiftSdk | | | | ------------------------- | --------------------------------------------------------- | @@ -451,19 +342,7 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_swiftSdk_oneOf_i0](#generate_swiftSdk_oneOf_i0) | -
- -
- -
-
- -
- - 2.5. [Optional] Property root > generate > llmTools - - -
+### 2.5. Property `root > generate > llmTools` | | | | ------------------------- | ---------------- | @@ -471,15 +350,11 @@ | **Required** | No | | **Additional properties** | Any type allowed | -
- | One of(Option) | | --------------------------------------- | | [llmTools](#generate_llmTools_oneOf_i0) | | [item 1](#generate_llmTools_oneOf_i1) | -
- #### 2.5.1. Property `root > generate > llmTools > oneOf > llmTools` | | | @@ -489,12 +364,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/llmTools | -
- - 2.5.1.1. [Optional] Property root > generate > llmTools > oneOf > item 0 > outputFile +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------ | +| - [outputFile](#generate_llmTools_oneOf_i0_outputFile ) | No | string | No | - | Path where the JSON LLM tool definitions file should be generated. | +| - [](#generate_llmTools_oneOf_i0_additionalProperties ) | No | object | No | - | - | - -
+##### 2.5.1.1. Property `root > generate > llmTools > oneOf > item 0 > outputFile` | | | | ------------ | -------- | @@ -503,12 +378,6 @@ **Description:** Path where the JSON LLM tool definitions file should be generated. -
-
- -
-
- #### 2.5.2. Property `root > generate > llmTools > oneOf > item 1` | | | @@ -528,7 +397,7 @@ | --------------------------------------------- | ----------- | | [llmTools](#generate_llmTools_oneOf_i1_items) | - | -##### 2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools +##### 2.5.2.1. root > generate > llmTools > oneOf > item 1 > llmTools | | | | ------------------------- | --------------------------------------------------------- | @@ -537,15 +406,5 @@ | **Additional properties** | Any type allowed | | **Same definition as** | [generate_llmTools_oneOf_i0](#generate_llmTools_oneOf_i0) | -
- -
- -
-
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:38:46 -0700 diff --git a/schema/docs/dataconnect-yaml.md b/schema/docs/dataconnect-yaml.md index f768005cf9e..ffcb5013286 100644 --- a/schema/docs/dataconnect-yaml.md +++ b/schema/docs/dataconnect-yaml.md @@ -8,12 +8,15 @@ **Description:** dataconnect.yaml is how you configure a Firebase Data Connect service. -
- - 1. [Optional] Property root > specVersion +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | --------------- | ---------- | ----------------------- | ------------------------------------------------------------------------------------------- | +| - [specVersion](#specVersion ) | No | string | No | - | The Firebase Data Connect API version to target. If omitted, defaults to the latest version | +| - [serviceId](#serviceId ) | No | string | No | - | The ID of the Firebase Data Connect service. | +| - [location](#location ) | No | string | No | - | The region of the Firebase Data Connect service. | +| - [connectorDirs](#connectorDirs ) | No | array of string | No | - | A list of directories containing conector.yaml files describing a connector to deploy. | +| - [schema](#schema ) | No | object | No | In #/definitions/schema | - | - -
+## 1. Property `root > specVersion` | | | | ------------ | -------- | @@ -22,15 +25,7 @@ **Description:** The Firebase Data Connect API version to target. If omitted, defaults to the latest version -
-
- -
- - 2. [Optional] Property root > serviceId - - -
+## 2. Property `root > serviceId` | | | | ------------ | -------- | @@ -39,15 +34,7 @@ **Description:** The ID of the Firebase Data Connect service. -
-
- -
- - 3. [Optional] Property root > location - - -
+## 3. Property `root > location` | | | | ------------ | -------- | @@ -56,15 +43,7 @@ **Description:** The region of the Firebase Data Connect service. -
-
- -
- - 4. [Optional] Property root > connectorDirs - - -
+## 4. Property `root > connectorDirs` | | | | ------------ | ----------------- | @@ -85,22 +64,14 @@ | ------------------------------------------- | ----------- | | [connectorDirs items](#connectorDirs_items) | - | -### 4.1. root > connectorDirs > connectorDirs items +### 4.1. root > connectorDirs > connectorDirs items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 5. [Optional] Property root > schema - - -
+## 5. Property `root > schema` | | | | ------------------------- | -------------------- | @@ -109,12 +80,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/schema | -
- - 5.1. [Optional] Property root > schema > source +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------ | +| - [source](#schema_source ) | No | string | No | - | Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema. | +| - [datasource](#schema_datasource ) | No | object | No | In #/definitions/dataSource | - | - -
+### 5.1. Property `root > schema > source` | | | | ------------ | -------- | @@ -123,15 +94,7 @@ **Description:** Relative path to directory containing GQL files defining the schema. If omitted, defaults to ./schema. -
-
- -
- - 5.2. [Optional] Property root > schema > datasource - - -
+### 5.2. Property `root > schema > datasource` | | | | ------------------------- | ------------------------ | @@ -140,12 +103,11 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/dataSource | -
- - 5.2.1. [Optional] Property root > schema > datasource > postgresql +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------- | ------- | ------ | ---------- | --------------------------- | ----------------- | +| - [postgresql](#schema_datasource_postgresql ) | No | object | No | In #/definitions/postgresql | - | - -
+#### 5.2.1. Property `root > schema > datasource > postgresql` | | | | ------------------------- | ------------------------ | @@ -154,12 +116,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/postgresql | -
- - 5.2.1.1. [Optional] Property root > schema > datasource > postgresql > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------ | +| - [database](#schema_datasource_postgresql_database ) | No | string | No | - | The name of the PostgreSQL database. | +| - [cloudSql](#schema_datasource_postgresql_cloudSql ) | No | object | No | - | - | - -
+##### 5.2.1.1. Property `root > schema > datasource > postgresql > database` | | | | ------------ | -------- | @@ -168,15 +130,7 @@ **Description:** The name of the PostgreSQL database. -
-
- -
- - 5.2.1.2. [Optional] Property root > schema > datasource > postgresql > cloudSql - - -
+##### 5.2.1.2. Property `root > schema > datasource > postgresql > cloudSql` | | | | ------------------------- | ----------- | @@ -184,12 +138,12 @@ | **Required** | No | | **Additional properties** | Not allowed | -
- - 5.2.1.2.1. [Optional] Property root > schema > datasource > postgresql > cloudSql > instanceId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------- | +| - [instanceId](#schema_datasource_postgresql_cloudSql_instanceId ) | No | string | No | - | The ID of the CloudSQL instance for this database | +| - [schemaValidation](#schema_datasource_postgresql_cloudSql_schemaValidation ) | No | enum (of string) | No | - | Schema validation mode for schema migrations | - -
+###### 5.2.1.2.1. Property `root > schema > datasource > postgresql > cloudSql > instanceId` | | | | ------------ | -------- | @@ -198,15 +152,7 @@ **Description:** The ID of the CloudSQL instance for this database -
-
- -
- - 5.2.1.2.2. [Optional] Property root > schema > datasource > postgresql > cloudSql > schemaValidation - - -
+###### 5.2.1.2.2. Property `root > schema > datasource > postgresql > cloudSql > schemaValidation` | | | | ------------ | ------------------ | @@ -219,20 +165,5 @@ Must be one of: * "COMPATIBLE" * "STRICT" -
-
- -
-
- -
-
- -
-
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:38:46 -0700 diff --git a/schema/docs/extension-yaml.md b/schema/docs/extension-yaml.md index 7fe7ee71ae0..682e6e71093 100644 --- a/schema/docs/extension-yaml.md +++ b/schema/docs/extension-yaml.md @@ -8,12 +8,30 @@ **Description:** extension.yaml declares the resources and configurable parameters for a Firebase Extension. -
- - 1. [Optional] Property root > name - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------- | ------- | --------------- | ---------- | ----------------------- | -------------------------------------------------------------------------------------------------------------- | +| - [name](#name ) | No | string | No | - | ID of this extension (ie your-extension-name) | +| - [version](#version ) | No | string | No | - | Version of this extension. Follows https://semver.org/. | +| - [specVersion](#specVersion ) | No | string | No | - | Version of the extension.yaml spec that this file follows. Currently always 'v1beta' | +| - [license](#license ) | No | string | No | - | The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev | +| - [displayName](#displayName ) | No | string | No | - | Human readable name for this extension (ie 'Your Extension Name') | +| - [description](#description ) | No | string | No | - | A one to two sentence description of what this extension does | +| - [icon](#icon ) | No | string | No | - | The file name of this extension's icon | +| - [billingRequired](#billingRequired ) | No | boolean | No | - | Whether this extension requires a billing to be enabled on the project it is installed on | +| - [tags](#tags ) | No | array of string | No | - | A list of tags to help users find your extension in search | +| - [sourceUrl](#sourceUrl ) | No | string | No | - | The URL of the GitHub repo hosting this code | +| - [releaseNotesUrl](#releaseNotesUrl ) | No | string | No | - | A URL where users can view the full changelog or release notes for this extension | +| - [author](#author ) | No | object | No | In #/definitions/author | - | +| - [contributors](#contributors ) | No | array | No | - | - | +| - [apis](#apis ) | No | array | No | - | - | +| - [roles](#roles ) | No | array | No | - | - | +| - [externalServices](#externalServices ) | No | array | No | - | - | +| - [params](#params ) | No | array | No | - | - | +| - [resources](#resources ) | No | array | No | - | - | +| - [lifecycleEvents](#lifecycleEvents ) | No | array | No | - | - | +| - [events](#events ) | No | array | No | - | - | + +## 1. Property `root > name` | | | | ------------ | -------- | @@ -22,15 +40,7 @@ **Description:** ID of this extension (ie your-extension-name) -
-
- -
- - 2. [Optional] Property root > version - - -
+## 2. Property `root > version` | | | | ------------ | -------- | @@ -39,15 +49,7 @@ **Description:** Version of this extension. Follows https://semver.org/. -
-
- -
- - 3. [Optional] Property root > specVersion - - -
+## 3. Property `root > specVersion` | | | | ------------ | -------- | @@ -56,15 +58,7 @@ **Description:** Version of the extension.yaml spec that this file follows. Currently always 'v1beta' -
-
- -
- - 4. [Optional] Property root > license - - -
+## 4. Property `root > license` | | | | ------------ | -------- | @@ -73,15 +67,7 @@ **Description:** The software license agreement for this extension. Currently, only 'Apache-2.0' is permitted on extensions.dev -
-
- -
- - 5. [Optional] Property root > displayName - - -
+## 5. Property `root > displayName` | | | | ------------ | -------- | @@ -90,15 +76,7 @@ **Description:** Human readable name for this extension (ie 'Your Extension Name') -
-
- -
- - 6. [Optional] Property root > description - - -
+## 6. Property `root > description` | | | | ------------ | -------- | @@ -107,15 +85,7 @@ **Description:** A one to two sentence description of what this extension does -
-
- -
- - 7. [Optional] Property root > icon - - -
+## 7. Property `root > icon` | | | | ------------ | -------- | @@ -124,15 +94,7 @@ **Description:** The file name of this extension's icon -
-
- -
- - 8. [Optional] Property root > billingRequired - - -
+## 8. Property `root > billingRequired` | | | | ------------ | --------- | @@ -141,15 +103,7 @@ **Description:** Whether this extension requires a billing to be enabled on the project it is installed on -
-
- -
- - 9. [Optional] Property root > tags - - -
+## 9. Property `root > tags` | | | | ------------ | ----------------- | @@ -170,22 +124,14 @@ | ------------------------------- | ----------- | | [tags items](#tags_items) | - | -### 9.1. root > tags > tags items +### 9.1. root > tags > tags items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 10. [Optional] Property root > sourceUrl - - -
+## 10. Property `root > sourceUrl` | | | | ------------ | -------- | @@ -194,15 +140,7 @@ **Description:** The URL of the GitHub repo hosting this code -
-
- -
- - 11. [Optional] Property root > releaseNotesUrl - - -
+## 11. Property `root > releaseNotesUrl` | | | | ------------ | -------- | @@ -211,15 +149,7 @@ **Description:** A URL where users can view the full changelog or release notes for this extension -
-
- -
- - 12. [Optional] Property root > author - - -
+## 12. Property `root > author` | | | | ------------------------- | -------------------- | @@ -228,12 +158,13 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/author | -
- - 12.1. [Optional] Property root > author > authorName +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ | +| - [authorName](#author_authorName ) | No | string | No | - | The author's name | +| - [email](#author_email ) | No | string | No | - | A contact email for the author | +| - [url](#author_url ) | No | string | No | - | URL of the author's website | - -
+### 12.1. Property `root > author > authorName` | | | | ------------ | -------- | @@ -242,15 +173,7 @@ **Description:** The author's name -
-
- -
- - 12.2. [Optional] Property root > author > email - - -
+### 12.2. Property `root > author > email` | | | | ------------ | -------- | @@ -259,15 +182,7 @@ **Description:** A contact email for the author -
-
- -
- - 12.3. [Optional] Property root > author > url - - -
+### 12.3. Property `root > author > url` | | | | ------------ | -------- | @@ -276,18 +191,7 @@ **Description:** URL of the author's website -
-
- -
-
- -
- - 13. [Optional] Property root > contributors - - -
+## 13. Property `root > contributors` | | | | ------------ | ------- | @@ -306,7 +210,7 @@ | ------------------------------- | ----------- | | [author](#contributors_items) | - | -### 13.1. root > contributors > author +### 13.1. root > contributors > author | | | | ------------------------- | ----------------- | @@ -315,15 +219,7 @@ | **Additional properties** | Not allowed | | **Same definition as** | [author](#author) | -
-
- -
- - 14. [Optional] Property root > apis - - -
+## 14. Property `root > apis` | | | | ------------ | ------- | @@ -342,7 +238,7 @@ | ------------------------------- | ----------------------------------------------------------------------------- | | [api](#apis_items) | A Google API used by this extension. Will be enabled on extension deployment. | -### 14.1. root > apis > api +### 14.1. root > apis > api | | | | ------------------------- | ----------------- | @@ -353,12 +249,12 @@ **Description:** A Google API used by this extension. Will be enabled on extension deployment. -
- - 14.1.1. [Required] Property root > apis > apis items > apiName +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------- | +| + [apiName](#apis_items_apiName ) | No | string | No | - | Name of the Google API to enable. Should match the service name listed in https://console.cloud.google.com/apis/library | +| + [reason](#apis_items_reason ) | No | string | No | - | Why this extension needs this API enabled | - -
+#### 14.1.1. Property `root > apis > apis items > apiName` | | | | ------------ | -------- | @@ -371,15 +267,7 @@ | --------------------------------- | ------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```[^\.]+\.googleapis\.com``` [Test](https://regex101.com/?regex=%5B%5E%5C.%5D%2B%5C.googleapis%5C.com) | -
-
- -
- - 14.1.2. [Required] Property root > apis > apis items > reason - - -
+#### 14.1.2. Property `root > apis > apis items > reason` | | | | ------------ | -------- | @@ -388,18 +276,7 @@ **Description:** Why this extension needs this API enabled -
-
- -
-
- -
- - 15. [Optional] Property root > roles - - -
+## 15. Property `root > roles` | | | | ------------ | ------- | @@ -418,7 +295,7 @@ | ------------------------------- | --------------------------------------- | | [role](#roles_items) | An IAM role to grant to this extension. | -### 15.1. root > roles > role +### 15.1. root > roles > role | | | | ------------------------- | ------------------ | @@ -429,12 +306,13 @@ **Description:** An IAM role to grant to this extension. -
- - 15.1.1. [Required] Property root > roles > roles items > role +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [role](#roles_items_role ) | No | string | No | - | Name of the IAM role to grant. Must be on the list of allowed roles: https://firebase.google.com/docs/extensions/publishers/access#supported-roles | +| + [reason](#roles_items_reason ) | No | string | No | - | Why this extension needs this IAM role | +| - [resource](#roles_items_resource ) | No | string | No | - | What resource to grant this role on. If omitted, defaults to projects/${project_id} | - -
+#### 15.1.1. Property `root > roles > roles items > role` | | | | ------------ | -------- | @@ -447,15 +325,7 @@ | --------------------------------- | ------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```[a-zA-Z]+\.[a-zA-Z]+``` [Test](https://regex101.com/?regex=%5Ba-zA-Z%5D%2B%5C.%5Ba-zA-Z%5D%2B) | -
-
- -
- - 15.1.2. [Required] Property root > roles > roles items > reason - - -
+#### 15.1.2. Property `root > roles > roles items > reason` | | | | ------------ | -------- | @@ -464,15 +334,7 @@ **Description:** Why this extension needs this IAM role -
-
- -
- - 15.1.3. [Optional] Property root > roles > roles items > resource - - -
+#### 15.1.3. Property `root > roles > roles items > resource` | | | | ------------ | -------- | @@ -481,18 +343,7 @@ **Description:** What resource to grant this role on. If omitted, defaults to projects/${project_id} -
-
- -
-
- -
- - 16. [Optional] Property root > externalServices - - -
+## 16. Property `root > externalServices` | | | | ------------ | ------- | @@ -511,7 +362,7 @@ | ------------------------------------------ | --------------------------------------- | | [externalService](#externalServices_items) | A non-Google API used by this extension | -### 16.1. root > externalServices > externalService +### 16.1. root > externalServices > externalService | | | | ------------------------- | ----------------------------- | @@ -522,12 +373,12 @@ **Description:** A non-Google API used by this extension -
- - 16.1.1. [Optional] Property root > externalServices > externalServices items > name +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [name](#externalServices_items_name ) | No | string | No | - | Name of the external service | +| - [pricingUri](#externalServices_items_pricingUri ) | No | string | No | - | URI to pricing information for the service | - -
+#### 16.1.1. Property `root > externalServices > externalServices items > name` | | | | ------------ | -------- | @@ -536,15 +387,7 @@ **Description:** Name of the external service -
-
- -
- - 16.1.2. [Optional] Property root > externalServices > externalServices items > pricingUri - - -
+#### 16.1.2. Property `root > externalServices > externalServices items > pricingUri` | | | | ------------ | -------- | @@ -553,18 +396,7 @@ **Description:** URI to pricing information for the service -
-
- -
-
- -
- - 17. [Optional] Property root > params - - -
+## 17. Property `root > params` | | | | ------------ | ------- | @@ -583,7 +415,7 @@ | ------------------------------- | -------------------------------------------------------------- | | [param](#params_items) | A parameter that users installing this extension can configure | -### 17.1. root > params > param +### 17.1. root > params > param | | | | ------------------------- | ------------------- | @@ -594,12 +426,23 @@ **Description:** A parameter that users installing this extension can configure -
- - 17.1.1. [Required] Property root > params > params items > param - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [param](#params_items_param ) | No | string | No | - | The name of the param. This is how you reference the param in your code | +| - [label](#params_items_label ) | No | string | No | - | Short description for the parameter. Displayed to users when they're prompted for the parameter's value. | +| - [description](#params_items_description ) | No | string | No | - | Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value. | +| - [example](#params_items_example ) | No | string | No | - | Example value for the parameter. | +| - [validationRegex](#params_items_validationRegex ) | No | string | No | - | Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax. | +| - [validationErrorMessage](#params_items_validationErrorMessage ) | No | string | No | - | Error message to display if regex validation fails. | +| - [default](#params_items_default ) | No | string | No | - | Default value for the parameter if the user leaves the parameter's value blank. | +| - [required](#params_items_required ) | No | boolean | No | - | Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true. | +| - [immutable](#params_items_immutable ) | No | boolean | No | - | Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false. | +| - [advanced](#params_items_advanced ) | No | boolean | No | - | Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param. | +| - [type](#params_items_type ) | No | string | No | - | The parameter type. Special parameter types might have additional requirements or different UI presentation. See https://firebase.google.com/docs/extensions/reference/extension-yaml#params for more details. | +| - [resourceType](#params_items_resourceType ) | No | string | No | - | The type of resource to prompt the user to select. Provides a special UI treatment for the param. | +| - [options](#params_items_options ) | No | array | No | - | Options for a select or multiSelect type param. | + +#### 17.1.1. Property `root > params > params items > param` | | | | ------------ | -------- | @@ -608,15 +451,7 @@ **Description:** The name of the param. This is how you reference the param in your code -
-
- -
- - 17.1.2. [Optional] Property root > params > params items > label - - -
+#### 17.1.2. Property `root > params > params items > label` | | | | ------------ | -------- | @@ -625,15 +460,7 @@ **Description:** Short description for the parameter. Displayed to users when they're prompted for the parameter's value. -
-
- -
- - 17.1.3. [Optional] Property root > params > params items > description - - -
+#### 17.1.3. Property `root > params > params items > description` | | | | ------------ | -------- | @@ -642,15 +469,7 @@ **Description:** Detailed description for the parameter. Displayed to users when they're prompted for the parameter's value. -
-
- -
- - 17.1.4. [Optional] Property root > params > params items > example - - -
+#### 17.1.4. Property `root > params > params items > example` | | | | ------------ | -------- | @@ -659,15 +478,7 @@ **Description:** Example value for the parameter. -
-
- -
- - 17.1.5. [Optional] Property root > params > params items > validationRegex - - -
+#### 17.1.5. Property `root > params > params items > validationRegex` | | | | ------------ | -------- | @@ -676,15 +487,7 @@ **Description:** Regular expression for validation of the parameter's user-configured value. Uses Google RE2 syntax. -
-
- -
- - 17.1.6. [Optional] Property root > params > params items > validationErrorMessage - - -
+#### 17.1.6. Property `root > params > params items > validationErrorMessage` | | | | ------------ | -------- | @@ -693,15 +496,7 @@ **Description:** Error message to display if regex validation fails. -
-
- -
- - 17.1.7. [Optional] Property root > params > params items > default - - -
+#### 17.1.7. Property `root > params > params items > default` | | | | ------------ | -------- | @@ -710,15 +505,7 @@ **Description:** Default value for the parameter if the user leaves the parameter's value blank. -
-
- -
- - 17.1.8. [Optional] Property root > params > params items > required - - -
+#### 17.1.8. Property `root > params > params items > required` | | | | ------------ | --------- | @@ -727,15 +514,7 @@ **Description:** Defines whether the user can submit an empty string when they're prompted for the parameter's value. Defaults to true. -
-
- -
- - 17.1.9. [Optional] Property root > params > params items > immutable - - -
+#### 17.1.9. Property `root > params > params items > immutable` | | | | ------------ | --------- | @@ -744,15 +523,7 @@ **Description:** Defines whether the user can change the parameter's value after installation (such as if they reconfigure the extension). Defaults to false. -
-
- -
- - 17.1.10. [Optional] Property root > params > params items > advanced - - -
+#### 17.1.10. Property `root > params > params items > advanced` | | | | ------------ | --------- | @@ -761,15 +532,7 @@ **Description:** Whether this a param for advanced users. When true, only users who choose 'advanced configuration' will see this param. -
-
- -
- - 17.1.11. [Optional] Property root > params > params items > type - - -
+#### 17.1.11. Property `root > params > params items > type` | | | | ------------ | -------- | @@ -782,15 +545,7 @@ | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```string\|select\|multiSelect\|secret\|selectResource``` [Test](https://regex101.com/?regex=string%7Cselect%7CmultiSelect%7Csecret%7CselectResource) | -
-
- -
- - 17.1.12. [Optional] Property root > params > params items > resourceType - - -
+#### 17.1.12. Property `root > params > params items > resourceType` | | | | ------------ | -------- | @@ -803,15 +558,7 @@ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```storage\.googleapis\.com\/Bucket\|firestore\.googleapis\.com\/Database\|firebasedatabase\.googleapis\.com\/DatabaseInstance``` [Test](https://regex101.com/?regex=storage%5C.googleapis%5C.com%5C%2FBucket%7Cfirestore%5C.googleapis%5C.com%5C%2FDatabase%7Cfirebasedatabase%5C.googleapis%5C.com%5C%2FDatabaseInstance) | -
-
- -
- - 17.1.13. [Optional] Property root > params > params items > options - - -
+#### 17.1.13. Property `root > params > params items > options` | | | | ------------ | ------- | @@ -832,7 +579,7 @@ | ------------------------------------------ | ----------- | | [paramOption](#params_items_options_items) | - | -##### 17.1.13.1. root > params > params items > options > paramOption +##### 17.1.13.1. root > params > params items > options > paramOption | | | | ------------------------- | ------------------------- | @@ -841,12 +588,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/paramOption | -
- - 17.1.13.1.1. [Required] Property root > params > params items > options > options items > value +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- | +| + [value](#params_items_options_items_value ) | No | string | No | - | One of the values the user can choose. This is the value you get when you read the parameter value in code. | +| - [label](#params_items_options_items_label ) | No | string | No | - | Short description of the selectable option. If omitted, defaults to value. | - -
+###### 17.1.13.1.1. Property `root > params > params items > options > options items > value` | | | | ------------ | -------- | @@ -855,15 +602,7 @@ **Description:** One of the values the user can choose. This is the value you get when you read the parameter value in code. -
-
- -
- - 17.1.13.1.2. [Optional] Property root > params > params items > options > options items > label - - -
+###### 17.1.13.1.2. Property `root > params > params items > options > options items > label` | | | | ------------ | -------- | @@ -872,21 +611,7 @@ **Description:** Short description of the selectable option. If omitted, defaults to value. -
-
- -
-
- -
-
- -
- - 18. [Optional] Property root > resources - - -
+## 18. Property `root > resources` | | | | ------------ | ------- | @@ -905,7 +630,7 @@ | ------------------------------- | ----------- | | [resource](#resources_items) | - | -### 18.1. root > resources > resource +### 18.1. root > resources > resource | | | | ------------------------- | ---------------------- | @@ -914,12 +639,14 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/resource | -
- - 18.1.1. [Required] Property root > resources > resources items > name +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| + [name](#resources_items_name ) | No | string | No | - | The name of this resource | +| + [type](#resources_items_type ) | No | string | No | - | What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options. | +| + [description](#resources_items_description ) | No | string | No | - | A brief description of what this resource does | +| + [properties](#resources_items_properties ) | No | object | No | - | The properties of this resource | - -
+#### 18.1.1. Property `root > resources > resources items > name` | | | | ------------ | -------- | @@ -928,15 +655,7 @@ **Description:** The name of this resource -
-
- -
- - 18.1.2. [Required] Property root > resources > resources items > type - - -
+#### 18.1.2. Property `root > resources > resources items > type` | | | | ------------ | -------- | @@ -945,15 +664,7 @@ **Description:** What type of resource this is. See https://firebase.google.com/docs/extensions/reference/extension-yaml#resources for a full list of options. -
-
- -
- - 18.1.3. [Required] Property root > resources > resources items > description - - -
+#### 18.1.3. Property `root > resources > resources items > description` | | | | ------------ | -------- | @@ -962,15 +673,7 @@ **Description:** A brief description of what this resource does -
-
- -
- - 18.1.4. [Required] Property root > resources > resources items > properties - - -
+#### 18.1.4. Property `root > resources > resources items > properties` | | | | ------------------------- | ---------------- | @@ -980,12 +683,23 @@ **Description:** The properties of this resource -
- - 18.1.4.1. [Optional] Property root > resources > resources items > properties > location - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| - [location](#resources_items_properties_location ) | No | string | No | - | The location for this resource | +| - [entryPoint](#resources_items_properties_entryPoint ) | No | string | No | - | The entry point for a function resource | +| - [sourceDirectory](#resources_items_properties_sourceDirectory ) | No | string | No | - | Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions | +| - [timeout](#resources_items_properties_timeout ) | No | string | No | - | A function resources's maximum execution time. | +| - [availableMemoryMb](#resources_items_properties_availableMemoryMb ) | No | string | No | - | Amount of memory in MB available for the function. | +| - [runtime](#resources_items_properties_runtime ) | No | string | No | - | Runtime environment for the function. Defaults to the most recent LTS version of node. | +| - [httpsTrigger](#resources_items_properties_httpsTrigger ) | No | object | No | - | A function triggered by HTTPS calls | +| - [eventTrigger](#resources_items_properties_eventTrigger ) | No | object | No | - | A function triggered by a background event | +| - [scheduleTrigger](#resources_items_properties_scheduleTrigger ) | No | object | No | - | A function triggered at a regular interval by a Cloud Scheduler job | +| - [taskQueueTrigger](#resources_items_properties_taskQueueTrigger ) | No | object | No | - | A function triggered by a Cloud Task | +| - [buildConfig](#resources_items_properties_buildConfig ) | No | object | No | - | Build configuration for a gen 2 Cloud Function | +| - [serviceConfig](#resources_items_properties_serviceConfig ) | No | object | No | - | Service configuration for a gen 2 Cloud Function | +| - [](#resources_items_properties_additionalProperties ) | No | object | No | - | - | + +##### 18.1.4.1. Property `root > resources > resources items > properties > location` | | | | ------------ | -------- | @@ -994,15 +708,7 @@ **Description:** The location for this resource -
-
- -
- - 18.1.4.2. [Optional] Property root > resources > resources items > properties > entryPoint - - -
+##### 18.1.4.2. Property `root > resources > resources items > properties > entryPoint` | | | | ------------ | -------- | @@ -1011,15 +717,7 @@ **Description:** The entry point for a function resource -
-
- -
- - 18.1.4.3. [Optional] Property root > resources > resources items > properties > sourceDirectory - - -
+##### 18.1.4.3. Property `root > resources > resources items > properties > sourceDirectory` | | | | ------------ | -------- | @@ -1028,15 +726,7 @@ **Description:** Directory that contains your package.json at its root. The file for your functions source code must be in this directory. Defaults to functions -
-
- -
- - 18.1.4.4. [Optional] Property root > resources > resources items > properties > timeout - - -
+##### 18.1.4.4. Property `root > resources > resources items > properties > timeout` | | | | ------------ | -------- | @@ -1049,15 +739,7 @@ | --------------------------------- | ------------------------------------------------------- | | **Must match regular expression** | ```\d+s``` [Test](https://regex101.com/?regex=%5Cd%2Bs) | -
-
- -
- - 18.1.4.5. [Optional] Property root > resources > resources items > properties > availableMemoryMb - - -
+##### 18.1.4.5. Property `root > resources > resources items > properties > availableMemoryMb` | | | | ------------ | -------- | @@ -1070,15 +752,7 @@ | --------------------------------- | ----------------------------------------------------- | | **Must match regular expression** | ```\d+``` [Test](https://regex101.com/?regex=%5Cd%2B) | -
-
- -
- - 18.1.4.6. [Optional] Property root > resources > resources items > properties > runtime - - -
+##### 18.1.4.6. Property `root > resources > resources items > properties > runtime` | | | | ------------ | -------- | @@ -1087,15 +761,7 @@ **Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. -
-
- -
- - 18.1.4.7. [Optional] Property root > resources > resources items > properties > httpsTrigger - - -
+##### 18.1.4.7. Property `root > resources > resources items > properties > httpsTrigger` | | | | ------------------------- | ---------------- | @@ -1105,15 +771,7 @@ **Description:** A function triggered by HTTPS calls -
-
- -
- - 18.1.4.8. [Optional] Property root > resources > resources items > properties > eventTrigger - - -
+##### 18.1.4.8. Property `root > resources > resources items > properties > eventTrigger` | | | | ------------------------- | ---------------- | @@ -1123,12 +781,15 @@ **Description:** A function triggered by a background event -
- - 18.1.4.8.1. [Required] Property root > resources > resources items > properties > eventTrigger > eventType +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [eventType](#resources_items_properties_eventTrigger_eventType ) | No | string | No | - | The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list. | +| - [resource](#resources_items_properties_eventTrigger_resource ) | No | string | No | - | The name or pattern of the resource to trigger on | +| - [eventFilters](#resources_items_properties_eventTrigger_eventFilters ) | No | array | No | - | Filters that further limit the events to listen to. | +| - [channel](#resources_items_properties_eventTrigger_channel ) | No | string | No | - | The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel. | +| - [triggerRegion](#resources_items_properties_eventTrigger_triggerRegion ) | No | string | No | - | The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function. | - -
+###### 18.1.4.8.1. Property `root > resources > resources items > properties > eventTrigger > eventType` | | | | ------------ | -------- | @@ -1137,15 +798,7 @@ **Description:** The type of background event to trigger on. See https://firebase.google.com/docs/extensions/publishers/functions#supported for a full list. -
-
- -
- - 18.1.4.8.2. [Optional] Property root > resources > resources items > properties > eventTrigger > resource - - -
+###### 18.1.4.8.2. Property `root > resources > resources items > properties > eventTrigger > resource` | | | | ------------ | -------- | @@ -1154,15 +807,7 @@ **Description:** The name or pattern of the resource to trigger on -
-
- -
- - 18.1.4.8.3. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters - - -
+###### 18.1.4.8.3. Property `root > resources > resources items > properties > eventTrigger > eventFilters` | | | | ------------ | ------- | @@ -1183,7 +828,7 @@ | -------------------------------------------------------------------------- | ----------- | | [eventFilter](#resources_items_properties_eventTrigger_eventFilters_items) | - | -###### 18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter +###### 18.1.4.8.3.1. root > resources > resources items > properties > eventTrigger > eventFilters > eventFilter | | | | ------------------------- | ------------------------- | @@ -1192,12 +837,12 @@ | **Additional properties** | Any type allowed | | **Defined in** | #/definitions/eventFilter | -
- - 18.1.4.8.3.1.1. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------- | +| - [attribute](#resources_items_properties_eventTrigger_eventFilters_items_attribute ) | No | string | No | - | The event attribute to filter on | +| - [value](#resources_items_properties_eventTrigger_eventFilters_items_value ) | No | string | No | - | The value to filter for | - -
+###### 18.1.4.8.3.1.1. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > attribute` | | | | ------------ | -------- | @@ -1206,15 +851,7 @@ **Description:** The event attribute to filter on -
-
- -
- - 18.1.4.8.3.1.2. [Optional] Property root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value - - -
+###### 18.1.4.8.3.1.2. Property `root > resources > resources items > properties > eventTrigger > eventFilters > eventFilters items > value` | | | | ------------ | -------- | @@ -1223,18 +860,7 @@ **Description:** The value to filter for -
-
- -
-
- -
- - 18.1.4.8.4. [Optional] Property root > resources > resources items > properties > eventTrigger > channel - - -
+###### 18.1.4.8.4. Property `root > resources > resources items > properties > eventTrigger > channel` | | | | ------------ | -------- | @@ -1243,15 +869,7 @@ **Description:** The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. If you omit this property, the function will listen for events on the project's default channel. -
-
- -
- - 18.1.4.8.5. [Optional] Property root > resources > resources items > properties > eventTrigger > triggerRegion - - -
+###### 18.1.4.8.5. Property `root > resources > resources items > properties > eventTrigger > triggerRegion` | | | | ------------ | -------- | @@ -1260,18 +878,7 @@ **Description:** The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function. -
-
- -
-
- -
- - 18.1.4.9. [Optional] Property root > resources > resources items > properties > scheduleTrigger - - -
+##### 18.1.4.9. Property `root > resources > resources items > properties > scheduleTrigger` | | | | ------------------------- | ---------------- | @@ -1281,12 +888,12 @@ **Description:** A function triggered at a regular interval by a Cloud Scheduler job -
- - 18.1.4.9.1. [Required] Property root > resources > resources items > properties > scheduleTrigger > schedule +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [schedule](#resources_items_properties_scheduleTrigger_schedule ) | No | string | No | - | The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax. | +| - [timeZone](#resources_items_properties_scheduleTrigger_timeZone ) | No | string | No | - | The time zone in which the schedule will run. Defaults to UTC. | - -
+###### 18.1.4.9.1. Property `root > resources > resources items > properties > scheduleTrigger > schedule` | | | | ------------ | -------- | @@ -1295,15 +902,7 @@ **Description:** The frequency at which you want the function to run. Accepts unix-cron (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) or App Engine (https://cloud.google.com/appengine/docs/standard/nodejs/scheduling-jobs-with-cron-yaml#defining_the_cron_job_schedule) syntax. -
-
- -
- - 18.1.4.9.2. [Optional] Property root > resources > resources items > properties > scheduleTrigger > timeZone - - -
+###### 18.1.4.9.2. Property `root > resources > resources items > properties > scheduleTrigger > timeZone` | | | | ------------ | -------- | @@ -1312,18 +911,7 @@ **Description:** The time zone in which the schedule will run. Defaults to UTC. -
-
- -
-
- -
- - 18.1.4.10. [Optional] Property root > resources > resources items > properties > taskQueueTrigger - - -
+##### 18.1.4.10. Property `root > resources > resources items > properties > taskQueueTrigger` | | | | ------------------------- | ---------------- | @@ -1333,15 +921,7 @@ **Description:** A function triggered by a Cloud Task -
-
- -
- - 18.1.4.11. [Optional] Property root > resources > resources items > properties > buildConfig - - -
+##### 18.1.4.11. Property `root > resources > resources items > properties > buildConfig` | | | | ------------------------- | ---------------- | @@ -1351,12 +931,12 @@ **Description:** Build configuration for a gen 2 Cloud Function -
- - 18.1.4.11.1. [Optional] Property root > resources > resources items > properties > buildConfig > runtime +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------- | +| - [runtime](#resources_items_properties_buildConfig_runtime ) | No | string | No | - | Runtime environment for the function. Defaults to the most recent LTS version of node. | +| - [entryPoint](#resources_items_properties_buildConfig_entryPoint ) | No | string | No | - | The entry point for a function resource | - -
+###### 18.1.4.11.1. Property `root > resources > resources items > properties > buildConfig > runtime` | | | | ------------ | -------- | @@ -1365,15 +945,7 @@ **Description:** Runtime environment for the function. Defaults to the most recent LTS version of node. -
-
- -
- - 18.1.4.11.2. [Optional] Property root > resources > resources items > properties > buildConfig > entryPoint - - -
+###### 18.1.4.11.2. Property `root > resources > resources items > properties > buildConfig > entryPoint` | | | | ------------ | -------- | @@ -1382,18 +954,7 @@ **Description:** The entry point for a function resource -
-
- -
-
- -
- - 18.1.4.12. [Optional] Property root > resources > resources items > properties > serviceConfig - - -
+##### 18.1.4.12. Property `root > resources > resources items > properties > serviceConfig` | | | | ------------------------- | ---------------- | @@ -1403,12 +964,12 @@ **Description:** Service configuration for a gen 2 Cloud Function -
- - 18.1.4.12.1. [Optional] Property root > resources > resources items > properties > serviceConfig > timeoutSeconds +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [timeoutSeconds](#resources_items_properties_serviceConfig_timeoutSeconds ) | No | string | No | - | The function's maximum execution time. Default: 60, max value: 540. | +| - [availableMemory](#resources_items_properties_serviceConfig_availableMemory ) | No | string | No | - | The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes. | - -
+###### 18.1.4.12.1. Property `root > resources > resources items > properties > serviceConfig > timeoutSeconds` | | | | ------------ | -------- | @@ -1417,15 +978,7 @@ **Description:** The function's maximum execution time. Default: 60, max value: 540. -
-
- -
- - 18.1.4.12.2. [Optional] Property root > resources > resources items > properties > serviceConfig > availableMemory - - -
+###### 18.1.4.12.2. Property `root > resources > resources items > properties > serviceConfig > availableMemory` | | | | ------------ | -------- | @@ -1434,24 +987,7 @@ **Description:** The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied, the value is interpreted as bytes. -
-
- -
-
- -
-
- -
-
- -
- - 19. [Optional] Property root > lifecycleEvents - - -
+## 19. Property `root > lifecycleEvents` | | | | ------------ | ------- | @@ -1470,7 +1006,7 @@ | ---------------------------------------- | ----------- | | [lifecycleEvent](#lifecycleEvents_items) | - | -### 19.1. root > lifecycleEvents > lifecycleEvent +### 19.1. root > lifecycleEvents > lifecycleEvent | | | | ------------------------- | ---------------------------- | @@ -1479,12 +1015,13 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/lifecycleEvent | -
- - 19.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------ | ----------------- | +| - [onInstall](#lifecycleEvents_items_onInstall ) | No | object | No | In #/definitions/lifecycleEventSpec | - | +| - [onUpdate](#lifecycleEvents_items_onUpdate ) | No | object | No | Same as [onInstall](#lifecycleEvents_items_onInstall ) | - | +| - [onConfigure](#lifecycleEvents_items_onConfigure ) | No | object | No | Same as [onInstall](#lifecycleEvents_items_onInstall ) | - | - -
+#### 19.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall` | | | | ------------------------- | -------------------------------- | @@ -1493,12 +1030,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/lifecycleEventSpec | -
- - 19.1.1.1. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| - [function](#lifecycleEvents_items_onInstall_function ) | No | string | No | - | Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section. | +| - [processingMessage](#lifecycleEvents_items_onInstall_processingMessage ) | No | string | No | - | Message to display in the Firebase console while the task is in progress. | - -
+##### 19.1.1.1. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > function` | | | | ------------ | -------- | @@ -1507,15 +1044,7 @@ **Description:** Name of the task queue-triggered function that will handle the event. This function must be a taskQueueTriggered function declared in the resources section. -
-
- -
- - 19.1.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage - - -
+##### 19.1.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onInstall > processingMessage` | | | | ------------ | -------- | @@ -1524,18 +1053,7 @@ **Description:** Message to display in the Firebase console while the task is in progress. -
-
- -
-
- -
- - 19.1.2. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onUpdate - - -
+#### 19.1.2. Property `root > lifecycleEvents > lifecycleEvents items > onUpdate` | | | | ------------------------- | --------------------------------------------- | @@ -1544,15 +1062,7 @@ | **Additional properties** | Not allowed | | **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | -
-
- -
- - 19.1.3. [Optional] Property root > lifecycleEvents > lifecycleEvents items > onConfigure - - -
+#### 19.1.3. Property `root > lifecycleEvents > lifecycleEvents items > onConfigure` | | | | ------------------------- | --------------------------------------------- | @@ -1561,18 +1071,7 @@ | **Additional properties** | Not allowed | | **Same definition as** | [onInstall](#lifecycleEvents_items_onInstall) | -
-
- -
-
- -
- - 20. [Optional] Property root > events - - -
+## 20. Property `root > events` | | | | ------------ | ------- | @@ -1591,7 +1090,7 @@ | ------------------------------- | ----------- | | [event](#events_items) | - | -### 20.1. root > events > event +### 20.1. root > events > event | | | | ------------------------- | ------------------- | @@ -1600,12 +1099,12 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/event | -
- - 20.1.1. [Optional] Property root > events > events items > type +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [type](#events_items_type ) | No | string | No | - | The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish. | +| - [description](#events_items_description ) | No | string | No | - | A description of the event | - -
+#### 20.1.1. Property `root > events > events items > type` | | | | ------------ | -------- | @@ -1614,15 +1113,7 @@ **Description:** The type identifier of the event. Construct the identifier out of 3-4 dot-delimited fields: the publisher ID, extension name, and event name fields are required; the version field is recommended. Choose a unique and descriptive event name for each event type you publish. -
-
- -
- - 20.1.2. [Optional] Property root > events > events items > description - - -
+#### 20.1.2. Property `root > events > events items > description` | | | | ------------ | -------- | @@ -1631,11 +1122,5 @@ **Description:** A description of the event -
-
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:38:46 -0700 diff --git a/schema/docs/firebase-config.md b/schema/docs/firebase-config.md index 54a8cc46692..1e151b678ab 100644 --- a/schema/docs/firebase-config.md +++ b/schema/docs/firebase-config.md @@ -9,12 +9,21 @@ **Description:** Information about the resources in your Firebase project. This used for declarative deployments via `firebase deploy` and local emulation via `firebase emulators:start` -
- - 1. [Optional] Property root > $schema +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------- | ------- | ----------- | ---------- | ----------------------------------- | ----------------------------------------------------------------------------- | +| - [$schema](#schema ) | No | string | No | - | Unused. Included in schema so that the schema can be applied to single files. | +| - [apphosting](#apphosting ) | No | Combination | No | - | The App Hosting backend(s) that should be deployed or emulated. | +| - [database](#database ) | No | Combination | No | - | The Realtime Database rules that should be deployed or emulated. | +| - [dataconnect](#dataconnect ) | No | Combination | No | - | The Data Connect service(s) that should be deployed or emulated. | +| - [emulators](#emulators ) | No | object | No | - | Hosts, ports, and configuration options for the Firebase Emulator suite. | +| - [extensions](#extensions ) | No | object | No | In #/definitions/ExtensionsConfig | The Firebase Extension(s) that should be deployed or emulated. | +| - [firestore](#firestore ) | No | Combination | No | - | The Firestore rules and indexes that should be deployed or emulated. | +| - [functions](#functions ) | No | Combination | No | - | The Cloud Functions for Firebase that should be deployed or emulated. | +| - [hosting](#hosting ) | No | Combination | No | - | The Firebase Hosting site(s) that should be deployed or emulated. | +| - [remoteconfig](#remoteconfig ) | No | object | No | In #/definitions/RemoteConfigConfig | The Remote Config template(s) used by this project. | +| - [storage](#storage ) | No | Combination | No | - | The Firebase Storage rules that should be deployed or emulated. | - -
+## 1. Property `root > $schema` | | | | ------------ | -------- | @@ -24,15 +33,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Unused. Included in schema so that the schema can be applied to single files. -
-
- -
- - 2. [Optional] Property root > apphosting - - -
+## 2. Property `root > apphosting` | | | | ------------------------- | ---------------- | @@ -42,15 +43,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The App Hosting backend(s) that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------ | | [item 0](#apphosting_anyOf_i0) | | [item 1](#apphosting_anyOf_i1) | -
- ### 2.1. Property `root > apphosting > anyOf > item 0` | | | @@ -59,14 +56,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -**Description:** A single App Hosting deployment configs +**Description:** A single App Hosting deployment config -
- - 2.1.1. [Optional] Property root > apphosting > anyOf > item 0 > alwaysDeployFromSource +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [alwaysDeployFromSource](#apphosting_anyOf_i0_alwaysDeployFromSource ) | No | boolean | No | - | If true, this backend will only be deployed from local source, not from source control. | +| + [backendId](#apphosting_anyOf_i0_backendId ) | No | string | No | - | The ID of the backend that should be deployed. | +| + [ignore](#apphosting_anyOf_i0_ignore ) | No | array of string | No | - | A list of file paths to exclude from the archive that is uploaded for this backend. | +| + [rootDir](#apphosting_anyOf_i0_rootDir ) | No | string | No | - | The root directory of your app. This directory will be archived and uploaded during dpeloyment. | - -
+#### 2.1.1. Property `root > apphosting > anyOf > item 0 > alwaysDeployFromSource` | | | | ------------ | --------- | @@ -75,30 +74,16 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** If true, this backend will only be deployed from local source, not from source control. -
-
- -
- - 2.1.2. [Required] Property root > apphosting > anyOf > item 0 > backendId - - -
+#### 2.1.2. Property `root > apphosting > anyOf > item 0 > backendId` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 2.1.3. [Required] Property root > apphosting > anyOf > item 0 > ignore +**Description:** The ID of the backend that should be deployed. - -
+#### 2.1.3. Property `root > apphosting > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -119,33 +104,21 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------- | ----------- | | [ignore items](#apphosting_anyOf_i0_ignore_items) | - | -##### 2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items +##### 2.1.3.1. root > apphosting > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 2.1.4. [Required] Property root > apphosting > anyOf > item 0 > rootDir - - -
+#### 2.1.4. Property `root > apphosting > anyOf > item 0 > rootDir` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
-
+**Description:** The root directory of your app. This directory will be archived and uploaded during dpeloyment. ### 2.2. Property `root > apphosting > anyOf > item 1` @@ -164,11 +137,11 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------ | --------------------------------------- | -| [item 1 items](#apphosting_anyOf_i1_items) | A single App Hosting deployment configs | +| Each item of this array must be | Description | +| ------------------------------------------ | -------------------------------------- | +| [item 1 items](#apphosting_anyOf_i1_items) | A single App Hosting deployment config | -#### 2.2.1. root > apphosting > anyOf > item 1 > item 1 items +#### 2.2.1. root > apphosting > anyOf > item 1 > item 1 items | | | | ------------------------- | ----------- | @@ -176,14 +149,16 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -**Description:** A single App Hosting deployment configs +**Description:** A single App Hosting deployment config -
- - 2.2.1.1. [Optional] Property root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [alwaysDeployFromSource](#apphosting_anyOf_i1_items_alwaysDeployFromSource ) | No | boolean | No | - | If true, this backend will only be deployed from local source, not from source control. | +| + [backendId](#apphosting_anyOf_i1_items_backendId ) | No | string | No | - | The ID of the backend that should be deployed. | +| + [ignore](#apphosting_anyOf_i1_items_ignore ) | No | array of string | No | - | A list of file paths to exclude from the archive that is uploaded for this backend. | +| + [rootDir](#apphosting_anyOf_i1_items_rootDir ) | No | string | No | - | The root directory of your app. This directory will be archived and uploaded during dpeloyment. | - -
+##### 2.2.1.1. Property `root > apphosting > anyOf > item 1 > item 1 items > alwaysDeployFromSource` | | | | ------------ | --------- | @@ -192,30 +167,16 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** If true, this backend will only be deployed from local source, not from source control. -
-
- -
- - 2.2.1.2. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > backendId - - -
+##### 2.2.1.2. Property `root > apphosting > anyOf > item 1 > item 1 items > backendId` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 2.2.1.3. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > ignore +**Description:** The ID of the backend that should be deployed. - -
+##### 2.2.1.3. Property `root > apphosting > anyOf > item 1 > item 1 items > ignore` | | | | ------------ | ----------------- | @@ -236,44 +197,23 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------------- | ----------- | | [ignore items](#apphosting_anyOf_i1_items_ignore_items) | - | -###### 2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items +###### 2.2.1.3.1. root > apphosting > anyOf > item 1 > item 1 items > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 2.2.1.4. [Required] Property root > apphosting > anyOf > item 1 > item 1 items > rootDir - - -
+##### 2.2.1.4. Property `root > apphosting > anyOf > item 1 > item 1 items > rootDir` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- -
- -
-
+**Description:** The root directory of your app. This directory will be archived and uploaded during dpeloyment. -
- - 3. [Optional] Property root > database - - -
+## 3. Property `root > database` | | | | ------------------------- | ---------------- | @@ -283,15 +223,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The Realtime Database rules that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------------ | | [DatabaseSingle](#database_anyOf_i0) | | [item 1](#database_anyOf_i1) | -
- ### 3.1. Property `root > database > anyOf > DatabaseSingle` | | | @@ -303,12 +239,13 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Deployment options for a single Realtime Database instance. -
- - 3.1.1. [Optional] Property root > database > anyOf > item 0 > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [postdeploy](#database_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#database_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#database_anyOf_i0_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | - -
+#### 3.1.1. Property `root > database > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -318,15 +255,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------------ | | [item 0](#database_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 3.1.1.1. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -346,16 +279,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------------------ | ----------- | | [item 0 items](#database_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 3.1.1.1.1. root > database > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 3.1.1.2. Property `root > database > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -363,19 +293,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.1.2. [Optional] Property root > database > anyOf > item 0 > predeploy - - -
+#### 3.1.2. Property `root > database > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -385,15 +303,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ----------------------------------------------- | | [item 0](#database_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 3.1.2.1. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -413,16 +327,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | ----------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 3.1.2.1.1. root > database > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 3.1.2.2. Property `root > database > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -430,19 +341,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.1.3. [Required] Property root > database > anyOf > item 0 > rules - - -
+#### 3.1.3. Property `root > database > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -451,12 +350,6 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -
-
- -
-
- ### 3.2. Property `root > database > anyOf > item 1` | | | @@ -478,7 +371,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ---------------------------------------- | ----------- | | [item 1 items](#database_anyOf_i1_items) | - | -#### 3.2.1. root > database > anyOf > item 1 > item 1 items +#### 3.2.1. root > database > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -486,15 +379,11 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Any type allowed | -
- | Any of(Option) | | ------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1) | -
- ##### 3.2.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -503,12 +392,15 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -
- - 3.2.1.1.1. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| + [instance](#database_anyOf_i1_items_anyOf_i0_instance ) | No | string | No | - | The instance that this rules files is for. | +| - [postdeploy](#database_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#database_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#database_anyOf_i1_items_anyOf_i0_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | +| - [target](#database_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | - | - -
+###### 3.2.1.1.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > instance` | | | | ------------ | -------- | @@ -517,15 +409,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The instance that this rules files is for. -
-
- -
- - 3.2.1.1.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy - - -
+###### 3.2.1.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -535,15 +419,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | -
- ###### 3.2.1.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -563,16 +443,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 3.2.1.1.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -580,19 +457,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.1.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy - - -
+###### 3.2.1.1.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -602,15 +467,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | -
- ###### 3.2.1.1.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -630,16 +491,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 3.2.1.1.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.1.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -647,19 +505,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.1.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules - - -
+###### 3.2.1.1.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -668,27 +514,13 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -
-
- -
- - 3.2.1.1.5. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target - - -
+###### 3.2.1.1.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 0 > target` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- ##### 3.2.1.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -697,12 +529,15 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Required** | No | | **Additional properties** | Not allowed | -
- - 3.2.1.2.1. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [instance](#database_anyOf_i1_items_anyOf_i1_instance ) | No | string | No | - | The instance that this rules files is for. | +| - [postdeploy](#database_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#database_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#database_anyOf_i1_items_anyOf_i1_rules ) | No | string | No | - | The rules files for this Realtime Database instance. | +| + [target](#database_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | - | - -
+###### 3.2.1.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > instance` | | | | ------------ | -------- | @@ -711,15 +546,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The instance that this rules files is for. -
-
- -
- - 3.2.1.2.2. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy - - -
+###### 3.2.1.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` | | | | ------------------------- | ---------------- | @@ -729,15 +556,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | -
- ###### 3.2.1.2.2.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -757,16 +580,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 3.2.1.2.2.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.2.2.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -774,19 +594,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.2.3. [Optional] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy - - -
+###### 3.2.1.2.3. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` | | | | ------------------------- | ---------------- | @@ -796,15 +604,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | -
- ###### 3.2.1.2.3.1. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -824,16 +628,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#database_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 3.2.1.2.3.1.1. root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 3.2.1.2.3.2. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -841,19 +642,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 3.2.1.2.4. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules - - -
+###### 3.2.1.2.4. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > rules` | | | | ------------ | -------- | @@ -862,41 +651,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The rules files for this Realtime Database instance. -
-
- -
- - 3.2.1.2.5. [Required] Property root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target - - -
+###### 3.2.1.2.5. Property `root > database > anyOf > item 1 > item 1 items > anyOf > item 1 > target` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- -
- -
- -
- -
-
- -
- - 4. [Optional] Property root > dataconnect - - -
+## 4. Property `root > dataconnect` | | | | ------------------------- | ---------------- | @@ -906,15 +668,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The Data Connect service(s) that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------------------ | | [DataConnectSingle](#dataconnect_anyOf_i0) | | [item 1](#dataconnect_anyOf_i1) | -
- ### 4.1. Property `root > dataconnect > anyOf > DataConnectSingle` | | | @@ -926,12 +684,13 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single Data Connect deployment configs -
- - 4.1.1. [Optional] Property root > dataconnect > anyOf > item 0 > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [postdeploy](#dataconnect_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#dataconnect_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [source](#dataconnect_anyOf_i0_source ) | No | string | No | - | The directory containing dataconnect.yaml for this service | - -
+#### 4.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -941,15 +700,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | --------------------------------------------------- | | [item 0](#dataconnect_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#dataconnect_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 4.1.1.1. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -969,16 +724,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | --------------------------------------------------------------- | ----------- | | [item 0 items](#dataconnect_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 4.1.1.1.1. root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 4.1.1.2. Property `root > dataconnect > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -986,19 +738,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 4.1.2. [Optional] Property root > dataconnect > anyOf > item 0 > predeploy - - -
+#### 4.1.2. Property `root > dataconnect > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -1008,15 +748,11 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | -------------------------------------------------- | | [item 0](#dataconnect_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#dataconnect_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 4.1.2.1. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -1036,16 +772,13 @@ This used for declarative deployments via `firebase deploy` and local emulation | -------------------------------------------------------------- | ----------- | | [item 0 items](#dataconnect_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 4.1.2.1.1. root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 4.1.2.2. Property `root > dataconnect > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -1053,30 +786,14 @@ This used for declarative deployments via `firebase deploy` and local emulation | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 4.1.3. [Required] Property root > dataconnect > anyOf > item 0 > source - - -
+#### 4.1.3. Property `root > dataconnect > anyOf > item 0 > source` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
-
+**Description:** The directory containing dataconnect.yaml for this service ### 4.2. Property `root > dataconnect > anyOf > item 1` @@ -1099,7 +816,7 @@ This used for declarative deployments via `firebase deploy` and local emulation | ------------------------------------------------ | ---------------------------------------- | | [DataConnectSingle](#dataconnect_anyOf_i1_items) | A single Data Connect deployment configs | -#### 4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle +#### 4.2.1. root > dataconnect > anyOf > item 1 > DataConnectSingle | | | | ------------------------- | --------------------------------------------- | @@ -1110,19 +827,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** A single Data Connect deployment configs -
- -
- -
-
- -
- - 5. [Optional] Property root > emulators - - -
+## 5. Property `root > emulators` | | | | ------------------------- | ----------- | @@ -1132,12 +837,25 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Hosts, ports, and configuration options for the Firebase Emulator suite. -
- - 5.1. [Optional] Property root > emulators > apphosting - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------------------- | +| - [apphosting](#emulators_apphosting ) | No | object | No | - | Config for the App Hosting emulator | +| - [auth](#emulators_auth ) | No | object | No | - | Config for the Auth emulator | +| - [database](#emulators_database ) | No | object | No | - | Config for the Realtime Database emulator | +| - [dataconnect](#emulators_dataconnect ) | No | object | No | - | Config for the Data Connect emulator. | +| - [eventarc](#emulators_eventarc ) | No | object | No | - | Config for the EventArc emulator. | +| - [extensions](#emulators_extensions ) | No | object | No | - | Placeholder - the Extensions emulator has no configuration options. | +| - [firestore](#emulators_firestore ) | No | object | No | - | Config for the Firestore emulator | +| - [hosting](#emulators_hosting ) | No | object | No | - | Config for the Firebase Hosting emulator | +| - [hub](#emulators_hub ) | No | object | No | - | Config for the emulator suite hub. | +| - [logging](#emulators_logging ) | No | object | No | - | Config for the logging emulator. | +| - [pubsub](#emulators_pubsub ) | No | object | No | - | Config for the Pub/Sub emulator | +| - [singleProjectMode](#emulators_singleProjectMode ) | No | boolean | No | - | If true, the Emulator Suite will only allow a single project to be used at a time. | +| - [storage](#emulators_storage ) | No | object | No | - | Config for the Firebase Storage emulator | +| - [tasks](#emulators_tasks ) | No | object | No | - | Config for the Cloud Tasks emulator. | +| - [ui](#emulators_ui ) | No | object | No | - | Config for the Emulator UI. | + +### 5.1. Property `root > emulators > apphosting` | | | | ------------------------- | ----------- | @@ -1147,12 +865,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the App Hosting emulator -
- - 5.1.1. [Optional] Property root > emulators > apphosting > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------- | +| - [host](#emulators_apphosting_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_apphosting_port ) | No | number | No | - | The port that this emulator will serve on. | +| - [rootDirectory](#emulators_apphosting_rootDirectory ) | No | string | No | - | The root directory of your app. The start command will ran from this directory. | +| - [startCommand](#emulators_apphosting_startCommand ) | No | string | No | - | The command that will be run to start your app when emulating your App Hosting backend | +| - [startCommandOverride](#emulators_apphosting_startCommandOverride ) | No | string | No | - | - | - -
+#### 5.1.1. Property `root > emulators > apphosting > host` | | | | ------------ | -------- | @@ -1161,15 +882,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -
-
- -
- - 5.1.2. [Optional] Property root > emulators > apphosting > port - - -
+#### 5.1.2. Property `root > emulators > apphosting > port` | | | | ------------ | -------- | @@ -1178,15 +891,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -
-
- -
- - 5.1.3. [Optional] Property root > emulators > apphosting > rootDirectory - - -
+#### 5.1.3. Property `root > emulators > apphosting > rootDirectory` | | | | ------------ | -------- | @@ -1195,15 +900,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The root directory of your app. The start command will ran from this directory. -
-
- -
- - 5.1.4. [Optional] Property root > emulators > apphosting > startCommand - - -
+#### 5.1.4. Property `root > emulators > apphosting > startCommand` | | | | ------------ | -------- | @@ -1212,33 +909,14 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The command that will be run to start your app when emulating your App Hosting backend -
-
- -
- - 5.1.5. [Optional] Property root > emulators > apphosting > startCommandOverride - - -
+#### 5.1.5. Property `root > emulators > apphosting > startCommandOverride` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- -
- - 5.2. [Optional] Property root > emulators > auth - - -
+### 5.2. Property `root > emulators > auth` | | | | ------------------------- | ----------- | @@ -1248,12 +926,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Auth emulator -
- - 5.2.1. [Optional] Property root > emulators > auth > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_auth_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_auth_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.2.1. Property `root > emulators > auth > host` | | | | ------------ | -------- | @@ -1262,15 +940,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -
-
- -
- - 5.2.2. [Optional] Property root > emulators > auth > port - - -
+#### 5.2.2. Property `root > emulators > auth > port` | | | | ------------ | -------- | @@ -1279,18 +949,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.3. [Optional] Property root > emulators > database - - -
+### 5.3. Property `root > emulators > database` | | | | ------------------------- | ----------- | @@ -1300,12 +959,12 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Realtime Database emulator -
- - 5.3.1. [Optional] Property root > emulators > database > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_database_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_database_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.3.1. Property `root > emulators > database > host` | | | | ------------ | -------- | @@ -1314,15 +973,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The host that this emulator will serve on. -
-
- -
- - 5.3.2. [Optional] Property root > emulators > database > port - - -
+#### 5.3.2. Property `root > emulators > database > port` | | | | ------------ | -------- | @@ -1331,18 +982,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.4. [Optional] Property root > emulators > dataconnect - - -
+### 5.4. Property `root > emulators > dataconnect` | | | | ------------------------- | ----------- | @@ -1352,12 +992,15 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** Config for the Data Connect emulator. -
- - 5.4.1. [Optional] Property root > emulators > dataconnect > dataDir +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [dataDir](#emulators_dataconnect_dataDir ) | No | string | No | - | The directory to persist emulator data to. If set, data will be saved between runs automatically.
If the --import flag is used, the current data will be overwritten by the imported data. | +| - [host](#emulators_dataconnect_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_dataconnect_port ) | No | number | No | - | The port that this emulator will serve on. | +| - [postgresHost](#emulators_dataconnect_postgresHost ) | No | string | No | - | Host for the Postgres database that backs the Data Connect emulator. | +| - [postgresPort](#emulators_dataconnect_postgresPort ) | No | number | No | - | Port for the Postgres database that backs the Data Connect emulator. | - -
+#### 5.4.1. Property `root > emulators > dataconnect > dataDir` | | | | ------------ | -------- | @@ -1367,15 +1010,7 @@ This used for declarative deployments via `firebase deploy` and local emulation **Description:** The directory to persist emulator data to. If set, data will be saved between runs automatically. If the --import flag is used, the current data will be overwritten by the imported data. -
-
- -
- - 5.4.2. [Optional] Property root > emulators > dataconnect > host - - -
+#### 5.4.2. Property `root > emulators > dataconnect > host` | | | | ------------ | -------- | @@ -1384,15 +1019,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.4.3. [Optional] Property root > emulators > dataconnect > port - - -
+#### 5.4.3. Property `root > emulators > dataconnect > port` | | | | ------------ | -------- | @@ -1401,15 +1028,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
- - 5.4.4. [Optional] Property root > emulators > dataconnect > postgresHost - - -
+#### 5.4.4. Property `root > emulators > dataconnect > postgresHost` | | | | ------------ | -------- | @@ -1418,15 +1037,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Host for the Postgres database that backs the Data Connect emulator. -
-
- -
- - 5.4.5. [Optional] Property root > emulators > dataconnect > postgresPort - - -
+#### 5.4.5. Property `root > emulators > dataconnect > postgresPort` | | | | ------------ | -------- | @@ -1435,18 +1046,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Port for the Postgres database that backs the Data Connect emulator. -
-
- -
-
- -
- - 5.5. [Optional] Property root > emulators > eventarc - - -
+### 5.5. Property `root > emulators > eventarc` | | | | ------------------------- | ----------- | @@ -1456,12 +1056,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the EventArc emulator. -
- - 5.5.1. [Optional] Property root > emulators > eventarc > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_eventarc_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_eventarc_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.5.1. Property `root > emulators > eventarc > host` | | | | ------------ | -------- | @@ -1470,15 +1070,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.5.2. [Optional] Property root > emulators > eventarc > port - - -
+#### 5.5.2. Property `root > emulators > eventarc > port` | | | | ------------ | -------- | @@ -1487,18 +1079,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.6. [Optional] Property root > emulators > extensions - - -
+### 5.6. Property `root > emulators > extensions` | | | | ------------------------- | ---------------- | @@ -1508,15 +1089,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Placeholder - the Extensions emulator has no configuration options. -
-
- -
- - 5.7. [Optional] Property root > emulators > firestore - - -
+### 5.7. Property `root > emulators > firestore` | | | | ------------------------- | ----------- | @@ -1526,12 +1099,13 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firestore emulator -
- - 5.7.1. [Optional] Property root > emulators > firestore > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_firestore_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_firestore_port ) | No | number | No | - | The port that this emulator will serve on. | +| - [websocketPort](#emulators_firestore_websocketPort ) | No | number | No | - | - | - -
+#### 5.7.1. Property `root > emulators > firestore > host` | | | | ------------ | -------- | @@ -1540,15 +1114,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.7.2. [Optional] Property root > emulators > firestore > port - - -
+#### 5.7.2. Property `root > emulators > firestore > port` | | | | ------------ | -------- | @@ -1557,33 +1123,14 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
- - 5.7.3. [Optional] Property root > emulators > firestore > websocketPort - - -
+#### 5.7.3. Property `root > emulators > firestore > websocketPort` | | | | ------------ | -------- | | **Type** | `number` | | **Required** | No | -
-
- -
-
- -
- - 5.8. [Optional] Property root > emulators > hosting - - -
+### 5.8. Property `root > emulators > hosting` | | | | ------------------------- | ----------- | @@ -1593,12 +1140,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firebase Hosting emulator -
- - 5.8.1. [Optional] Property root > emulators > hosting > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_hosting_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_hosting_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.8.1. Property `root > emulators > hosting > host` | | | | ------------ | -------- | @@ -1607,15 +1154,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.8.2. [Optional] Property root > emulators > hosting > port - - -
+#### 5.8.2. Property `root > emulators > hosting > port` | | | | ------------ | -------- | @@ -1624,18 +1163,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.9. [Optional] Property root > emulators > hub - - -
+### 5.9. Property `root > emulators > hub` | | | | ------------------------- | ----------- | @@ -1645,12 +1173,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the emulator suite hub. -
- - 5.9.1. [Optional] Property root > emulators > hub > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_hub_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_hub_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.9.1. Property `root > emulators > hub > host` | | | | ------------ | -------- | @@ -1659,15 +1187,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.9.2. [Optional] Property root > emulators > hub > port - - -
+#### 5.9.2. Property `root > emulators > hub > port` | | | | ------------ | -------- | @@ -1676,18 +1196,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.10. [Optional] Property root > emulators > logging - - -
+### 5.10. Property `root > emulators > logging` | | | | ------------------------- | ----------- | @@ -1697,12 +1206,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the logging emulator. -
- - 5.10.1. [Optional] Property root > emulators > logging > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_logging_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_logging_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.10.1. Property `root > emulators > logging > host` | | | | ------------ | -------- | @@ -1711,15 +1220,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.10.2. [Optional] Property root > emulators > logging > port - - -
+#### 5.10.2. Property `root > emulators > logging > port` | | | | ------------ | -------- | @@ -1728,18 +1229,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.11. [Optional] Property root > emulators > pubsub - - -
+### 5.11. Property `root > emulators > pubsub` | | | | ------------------------- | ----------- | @@ -1749,12 +1239,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Pub/Sub emulator -
- - 5.11.1. [Optional] Property root > emulators > pubsub > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_pubsub_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_pubsub_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.11.1. Property `root > emulators > pubsub > host` | | | | ------------ | -------- | @@ -1763,15 +1253,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.11.2. [Optional] Property root > emulators > pubsub > port - - -
+#### 5.11.2. Property `root > emulators > pubsub > port` | | | | ------------ | -------- | @@ -1780,18 +1262,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.12. [Optional] Property root > emulators > singleProjectMode - - -
+### 5.12. Property `root > emulators > singleProjectMode` | | | | ------------ | --------- | @@ -1800,15 +1271,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** If true, the Emulator Suite will only allow a single project to be used at a time. -
-
- -
- - 5.13. [Optional] Property root > emulators > storage - - -
+### 5.13. Property `root > emulators > storage` | | | | ------------------------- | ----------- | @@ -1818,12 +1281,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Firebase Storage emulator -
- - 5.13.1. [Optional] Property root > emulators > storage > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_storage_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_storage_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.13.1. Property `root > emulators > storage > host` | | | | ------------ | -------- | @@ -1832,15 +1295,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.13.2. [Optional] Property root > emulators > storage > port - - -
+#### 5.13.2. Property `root > emulators > storage > port` | | | | ------------ | -------- | @@ -1849,18 +1304,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.14. [Optional] Property root > emulators > tasks - - -
+### 5.14. Property `root > emulators > tasks` | | | | ------------------------- | ----------- | @@ -1870,12 +1314,12 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Cloud Tasks emulator. -
- - 5.14.1. [Optional] Property root > emulators > tasks > host +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | +| - [host](#emulators_tasks_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_tasks_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.14.1. Property `root > emulators > tasks > host` | | | | ------------ | -------- | @@ -1884,15 +1328,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.14.2. [Optional] Property root > emulators > tasks > port - - -
+#### 5.14.2. Property `root > emulators > tasks > port` | | | | ------------ | -------- | @@ -1901,18 +1337,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
- - 5.15. [Optional] Property root > emulators > ui - - -
+### 5.15. Property `root > emulators > ui` | | | | ------------------------- | ----------- | @@ -1922,12 +1347,13 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Config for the Emulator UI. -
- - 5.15.1. [Optional] Property root > emulators > ui > enabled +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------- | ------- | ------- | ---------- | ---------- | --------------------------------------------- | +| - [enabled](#emulators_ui_enabled ) | No | boolean | No | - | If false, the Emulator UI will not be served. | +| - [host](#emulators_ui_host ) | No | string | No | - | The host that this emulator will serve on. | +| - [port](#emulators_ui_port ) | No | number | No | - | The port that this emulator will serve on. | - -
+#### 5.15.1. Property `root > emulators > ui > enabled` | | | | ------------ | --------- | @@ -1936,15 +1362,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** If false, the Emulator UI will not be served. -
-
- -
- - 5.15.2. [Optional] Property root > emulators > ui > host - - -
+#### 5.15.2. Property `root > emulators > ui > host` | | | | ------------ | -------- | @@ -1953,15 +1371,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The host that this emulator will serve on. -
-
- -
- - 5.15.3. [Optional] Property root > emulators > ui > port - - -
+#### 5.15.3. Property `root > emulators > ui > port` | | | | ------------ | -------- | @@ -1970,21 +1380,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The port that this emulator will serve on. -
-
- -
-
- -
-
- -
- - 6. [Optional] Property root > extensions - - -
+## 6. Property `root > extensions` | | | | ------------------------- | ------------------------------ | @@ -1995,15 +1391,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The Firebase Extension(s) that should be deployed or emulated. -
-
- -
- - 7. [Optional] Property root > firestore - - -
+## 7. Property `root > firestore` | | | | ------------------------- | ---------------- | @@ -2013,15 +1401,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The Firestore rules and indexes that should be deployed or emulated. -
- | Any of(Option) | | -------------------------------------- | | [FirestoreSingle](#firestore_anyOf_i0) | | [item 1](#firestore_anyOf_i1) | -
- ### 7.1. Property `root > firestore > anyOf > FirestoreSingle` | | | @@ -2033,12 +1417,16 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Deployment options for a single Firestore database. -
- - 7.1.1. [Optional] Property root > firestore > anyOf > item 0 > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------- | +| - [database](#firestore_anyOf_i0_database ) | No | string | No | - | The id of the Firestore database to deploy. If omitted, defaults to '(default)' | +| - [indexes](#firestore_anyOf_i0_indexes ) | No | string | No | - | Path to the firestore indexes file | +| - [location](#firestore_anyOf_i0_location ) | No | string | No | - | The region of the Firestore database to deploy. Required when 'database' is set. | +| - [postdeploy](#firestore_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#firestore_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [rules](#firestore_anyOf_i0_rules ) | No | string | No | - | Path to the firestore rules file | - -
+#### 7.1.1. Property `root > firestore > anyOf > item 0 > database` | | | | ------------ | -------- | @@ -2047,15 +1435,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The id of the Firestore database to deploy. If omitted, defaults to '(default)' -
-
- -
- - 7.1.2. [Optional] Property root > firestore > anyOf > item 0 > indexes - - -
+#### 7.1.2. Property `root > firestore > anyOf > item 0 > indexes` | | | | ------------ | -------- | @@ -2064,15 +1444,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore indexes file -
-
- -
- - 7.1.3. [Optional] Property root > firestore > anyOf > item 0 > location - - -
+#### 7.1.3. Property `root > firestore > anyOf > item 0 > location` | | | | ------------ | -------- | @@ -2081,15 +1453,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The region of the Firestore database to deploy. Required when 'database' is set. -
-
- -
- - 7.1.4. [Optional] Property root > firestore > anyOf > item 0 > postdeploy - - -
+#### 7.1.4. Property `root > firestore > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -2099,15 +1463,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------------- | | [item 0](#firestore_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 7.1.4.1. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -2127,16 +1487,13 @@ If the --import flag is used, the current data will be overwritten by the import | ------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 7.1.4.1.1. root > firestore > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 7.1.4.2. Property `root > firestore > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -2144,19 +1501,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.1.5. [Optional] Property root > firestore > anyOf > item 0 > predeploy - - -
+#### 7.1.5. Property `root > firestore > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -2166,15 +1511,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------ | | [item 0](#firestore_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 7.1.5.1. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -2194,16 +1535,13 @@ If the --import flag is used, the current data will be overwritten by the import | ------------------------------------------------------------ | ----------- | | [item 0 items](#firestore_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 7.1.5.1.1. root > firestore > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 7.1.5.2. Property `root > firestore > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -2211,19 +1549,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.1.6. [Optional] Property root > firestore > anyOf > item 0 > rules - - -
+#### 7.1.6. Property `root > firestore > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -2232,12 +1558,6 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore rules file -
-
- -
-
- ### 7.2. Property `root > firestore > anyOf > item 1` | | | @@ -2259,7 +1579,7 @@ If the --import flag is used, the current data will be overwritten by the import | ----------------------------------------- | ----------- | | [item 1 items](#firestore_anyOf_i1_items) | - | -#### 7.2.1. root > firestore > anyOf > item 1 > item 1 items +#### 7.2.1. root > firestore > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -2267,15 +1587,11 @@ If the --import flag is used, the current data will be overwritten by the import | **Required** | No | | **Additional properties** | Any type allowed | -
- | Any of(Option) | | -------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1) | -
- ##### 7.2.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -2284,12 +1600,16 @@ If the --import flag is used, the current data will be overwritten by the import | **Required** | No | | **Additional properties** | Not allowed | -
- - 7.2.1.1.1. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [database](#firestore_anyOf_i1_items_anyOf_i0_database ) | No | string | No | - | The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. | +| - [indexes](#firestore_anyOf_i1_items_anyOf_i0_indexes ) | No | string | No | - | Path to the firestore indexes file for this database | +| - [postdeploy](#firestore_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#firestore_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [rules](#firestore_anyOf_i1_items_anyOf_i0_rules ) | No | string | No | - | Path to the firestore rules file for this database | +| + [target](#firestore_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | The deploy target these rules and indexes should be deployed to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+###### 7.2.1.1.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > database` | | | | ------------ | -------- | @@ -2298,15 +1618,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. -
-
- -
- - 7.2.1.1.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes - - -
+###### 7.2.1.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > indexes` | | | | ------------ | -------- | @@ -2315,15 +1627,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore indexes file for this database -
-
- -
- - 7.2.1.1.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy - - -
+###### 7.2.1.1.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -2333,15 +1637,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ---------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | -
- ###### 7.2.1.1.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -2361,16 +1661,13 @@ If the --import flag is used, the current data will be overwritten by the import | ---------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 7.2.1.1.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.1.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -2378,19 +1675,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.1.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy - - -
+###### 7.2.1.1.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -2400,15 +1685,11 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | -
- ###### 7.2.1.1.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -2428,16 +1709,13 @@ If the --import flag is used, the current data will be overwritten by the import | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 7.2.1.1.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.1.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -2445,19 +1723,7 @@ If the --import flag is used, the current data will be overwritten by the import | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.1.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules - - -
+###### 7.2.1.1.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -2466,15 +1732,7 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** Path to the firestore rules file for this database -
-
- -
- - 7.2.1.1.6. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target - - -
+###### 7.2.1.1.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -2484,12 +1742,6 @@ If the --import flag is used, the current data will be overwritten by the import **Description:** The deploy target these rules and indexes should be deployed to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
-
- ##### 7.2.1.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -2498,12 +1750,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 7.2.1.2.1. [Required] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| + [database](#firestore_anyOf_i1_items_anyOf_i1_database ) | No | string | No | - | The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. | +| - [indexes](#firestore_anyOf_i1_items_anyOf_i1_indexes ) | No | string | No | - | Path to the firestore indexes file for this database | +| - [postdeploy](#firestore_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#firestore_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [rules](#firestore_anyOf_i1_items_anyOf_i1_rules ) | No | string | No | - | Path to the firestore rules file for this database | +| - [target](#firestore_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | The deploy target these rules and indexes should be deployed to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+###### 7.2.1.2.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > database` | | | | ------------ | -------- | @@ -2512,15 +1768,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The ID of the Firestore database to deploy. Required when deploying multiple Firestore databases. -
-
- -
- - 7.2.1.2.2. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes - - -
+###### 7.2.1.2.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > indexes` | | | | ------------ | -------- | @@ -2529,15 +1777,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the firestore indexes file for this database -
-
- -
- - 7.2.1.2.3. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy - - -
+###### 7.2.1.2.3. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` | | | | ------------------------- | ---------------- | @@ -2547,15 +1787,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ---------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | -
- ###### 7.2.1.2.3.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -2575,16 +1811,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 7.2.1.2.3.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.2.3.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -2592,19 +1825,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.2.4. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy - - -
+###### 7.2.1.2.4. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` | | | | ------------------------- | ---------------- | @@ -2614,15 +1835,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | --------------------------------------------------------------- | | [item 0](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | -
- ###### 7.2.1.2.4.1. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -2642,16 +1859,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------------------------------------------- | ----------- | | [item 0 items](#firestore_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 7.2.1.2.4.1.1. root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 7.2.1.2.4.2. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -2659,19 +1873,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 7.2.1.2.5. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules - - -
+###### 7.2.1.2.5. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > rules` | | | | ------------ | -------- | @@ -2680,15 +1882,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the firestore rules file for this database -
-
- -
- - 7.2.1.2.6. [Optional] Property root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target - - -
+###### 7.2.1.2.6. Property `root > firestore > anyOf > item 1 > item 1 items > anyOf > item 1 > target` | | | | ------------ | -------- | @@ -2698,26 +1892,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target these rules and indexes should be deployed to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- -
- -
- -
- -
-
- -
- - 8. [Optional] Property root > functions - - -
+## 8. Property `root > functions` | | | | ------------------------- | ---------------- | @@ -2727,15 +1902,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Cloud Functions for Firebase that should be deployed or emulated. -
- | Any of(Option) | | ------------------------------------- | | [FunctionConfig](#functions_anyOf_i0) | | [item 1](#functions_anyOf_i1) | -
- ### 8.1. Property `root > functions > anyOf > FunctionConfig` | | | @@ -2745,12 +1916,16 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/FunctionConfig | -
- - 8.1.1. [Optional] Property root > functions > anyOf > item 0 > codebase +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| - [codebase](#functions_anyOf_i0_codebase ) | No | string | No | - | The codebase that these functions are part of. You can use codebases to control which functions are deployed
ie: \`firebase deploy --only functions:my-codebase\` | +| - [ignore](#functions_anyOf_i0_ignore ) | No | array of string | No | - | Files in the source directory that should not be uploaed during dpeloyment. | +| - [postdeploy](#functions_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#functions_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [runtime](#functions_anyOf_i0_runtime ) | No | enum (of string) | No | - | The runtime these functions should use. | +| - [source](#functions_anyOf_i0_source ) | No | string | No | - | The directory containing your functions source code.
This directory will be archived and uploaded during deployment.
Files outside of this directory will not be included and should not be referenced from your functions code. | - -
+#### 8.1.1. Property `root > functions > anyOf > item 0 > codebase` | | | | ------------ | -------- | @@ -2760,15 +1935,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The codebase that these functions are part of. You can use codebases to control which functions are deployed ie: `firebase deploy --only functions:my-codebase` -
-
- -
- - 8.1.2. [Optional] Property root > functions > anyOf > item 0 > ignore - - -
+#### 8.1.2. Property `root > functions > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -2789,22 +1956,14 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------ | ----------- | | [ignore items](#functions_anyOf_i0_ignore_items) | - | -##### 8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items +##### 8.1.2.1. root > functions > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 8.1.3. [Optional] Property root > functions > anyOf > item 0 > postdeploy - - -
+#### 8.1.3. Property `root > functions > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -2814,15 +1973,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------------- | | [item 0](#functions_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#functions_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 8.1.3.1. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -2842,16 +1997,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------------- | ----------- | | [item 0 items](#functions_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 8.1.3.1.1. root > functions > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 8.1.3.2. Property `root > functions > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -2859,19 +2011,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 8.1.4. [Optional] Property root > functions > anyOf > item 0 > predeploy - - -
+#### 8.1.4. Property `root > functions > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -2881,15 +2021,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------ | | [item 0](#functions_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#functions_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 8.1.4.1. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -2909,16 +2045,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------------ | ----------- | | [item 0 items](#functions_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 8.1.4.1.1. root > functions > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 8.1.4.2. Property `root > functions > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -2926,19 +2059,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 8.1.5. [Optional] Property root > functions > anyOf > item 0 > runtime - - -
+#### 8.1.5. Property `root > functions > anyOf > item 0 > runtime` | | | | ------------ | ------------------ | @@ -2955,15 +2076,7 @@ Must be one of: * "python312" * "python313" -
-
- -
- - 8.1.6. [Optional] Property root > functions > anyOf > item 0 > source - - -
+#### 8.1.6. Property `root > functions > anyOf > item 0 > source` | | | | ------------ | -------- | @@ -2974,12 +2087,6 @@ Must be one of: This directory will be archived and uploaded during deployment. Files outside of this directory will not be included and should not be referenced from your functions code. -
-
- -
-
- ### 8.2. Property `root > functions > anyOf > item 1` | | | @@ -2999,7 +2106,7 @@ Files outside of this directory will not be included and should not be reference | ------------------------------------------- | ----------- | | [FunctionConfig](#functions_anyOf_i1_items) | - | -#### 8.2.1. root > functions > anyOf > item 1 > FunctionConfig +#### 8.2.1. root > functions > anyOf > item 1 > FunctionConfig | | | | ------------------------- | ----------------------------------------- | @@ -3008,19 +2115,7 @@ Files outside of this directory will not be included and should not be reference | **Additional properties** | Not allowed | | **Same definition as** | [functions_anyOf_i0](#functions_anyOf_i0) | -
- -
- -
-
- -
- - 9. [Optional] Property root > hosting - - -
+## 9. Property `root > hosting` | | | | ------------------------- | ---------------- | @@ -3030,15 +2125,11 @@ Files outside of this directory will not be included and should not be reference **Description:** The Firebase Hosting site(s) that should be deployed or emulated. -
- | Any of(Option) | | ---------------------------------- | | [HostingSingle](#hosting_anyOf_i0) | | [item 1](#hosting_anyOf_i1) | -
- ### 9.1. Property `root > hosting > anyOf > HostingSingle` | | | @@ -3050,12 +2141,25 @@ Files outside of this directory will not be included and should not be reference **Description:** Deployment options for a single Firebase Hosting site. -
- - 9.1.1. [Optional] Property root > hosting > anyOf > item 0 > appAssociation - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [appAssociation](#hosting_anyOf_i0_appAssociation ) | No | enum (of string) | No | - | - | +| - [cleanUrls](#hosting_anyOf_i0_cleanUrls ) | No | boolean | No | - | - | +| - [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | No | object | No | In #/definitions/FrameworksBackendOptions | Options for this sites web frameworks backend. | +| - [headers](#hosting_anyOf_i0_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | +| - [i18n](#hosting_anyOf_i0_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | +| - [ignore](#hosting_anyOf_i0_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | +| - [postdeploy](#hosting_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#hosting_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [public](#hosting_anyOf_i0_public ) | No | string | No | - | Whether this site should publically available. | +| - [redirects](#hosting_anyOf_i0_redirects ) | No | array | No | - | A list of redirects for this site. | +| - [rewrites](#hosting_anyOf_i0_rewrites ) | No | array | No | - | A list o rewrites for this site. | +| - [site](#hosting_anyOf_i0_site ) | No | string | No | - | The site to deploy. | +| - [source](#hosting_anyOf_i0_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | +| - [target](#hosting_anyOf_i0_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +| - [trailingSlash](#hosting_anyOf_i0_trailingSlash ) | No | boolean | No | - | - | + +#### 9.1.1. Property `root > hosting > anyOf > item 0 > appAssociation` | | | | ------------ | ------------------ | @@ -3066,30 +2170,14 @@ Must be one of: * "AUTO" * "NONE" -
-
- -
- - 9.1.2. [Optional] Property root > hosting > anyOf > item 0 > cleanUrls - - -
+#### 9.1.2. Property `root > hosting > anyOf > item 0 > cleanUrls` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- - 9.1.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend - - -
+#### 9.1.3. Property `root > hosting > anyOf > item 0 > frameworksBackend` | | | | ------------------------- | -------------------------------------- | @@ -3100,12 +2188,28 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -
- - 9.1.3.1. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > concurrency - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------------------------------- | ------- | ----------------- | ---------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [concurrency](#hosting_anyOf_i0_frameworksBackend_concurrency ) | No | number | No | - | Number of requests a function can serve at once. | +| - [cors](#hosting_anyOf_i0_frameworksBackend_cors ) | No | string or boolean | No | - | If true, allows CORS on requests to this function.
If this is a \`string\` or \`RegExp\`, allows requests from domains that match the provided value.
If this is an \`Array\`, allows requests from domains matching at least one entry of the array.
Defaults to true for {@link https.CallableFunction} and false otherwise. | +| - [cpu](#hosting_anyOf_i0_frameworksBackend_cpu ) | No | Combination | No | - | Fractional number of CPUs to allocate to a function. | +| - [enforceAppCheck](#hosting_anyOf_i0_frameworksBackend_enforceAppCheck ) | No | boolean | No | - | Determines whether Firebase AppCheck is enforced. Defaults to false. | +| - [ingressSettings](#hosting_anyOf_i0_frameworksBackend_ingressSettings ) | No | enum (of string) | No | - | Ingress settings which control where this function can be called from. | +| - [invoker](#hosting_anyOf_i0_frameworksBackend_invoker ) | No | const | No | - | Invoker to set access control on https functions. | +| - [labels](#hosting_anyOf_i0_frameworksBackend_labels ) | No | object | No | In #/definitions/Record | User labels to set on the function. | +| - [maxInstances](#hosting_anyOf_i0_frameworksBackend_maxInstances ) | No | number | No | - | Max number of instances to be running in parallel. | +| - [memory](#hosting_anyOf_i0_frameworksBackend_memory ) | No | enum (of string) | No | - | Amount of memory to allocate to a function. | +| - [minInstances](#hosting_anyOf_i0_frameworksBackend_minInstances ) | No | number | No | - | Min number of actual instances to be running at a given time. | +| - [omit](#hosting_anyOf_i0_frameworksBackend_omit ) | No | boolean | No | - | If true, do not deploy or emulate this function. | +| - [preserveExternalChanges](#hosting_anyOf_i0_frameworksBackend_preserveExternalChanges ) | No | boolean | No | - | Controls whether function configuration modified outside of function source is preserved. Defaults to false. | +| - [region](#hosting_anyOf_i0_frameworksBackend_region ) | No | string | No | - | HTTP functions can override global options and can specify multiple regions to deploy to. | +| - [secrets](#hosting_anyOf_i0_frameworksBackend_secrets ) | No | array of string | No | - | A list of secrets used in this app. | +| - [serviceAccount](#hosting_anyOf_i0_frameworksBackend_serviceAccount ) | No | string | No | - | Specific service account for the function to run as. | +| - [timeoutSeconds](#hosting_anyOf_i0_frameworksBackend_timeoutSeconds ) | No | number | No | - | Timeout for the function in seconds, possible values are 0 to 540.
HTTPS functions can specify a higher timeout. | +| - [vpcConnector](#hosting_anyOf_i0_frameworksBackend_vpcConnector ) | No | string | No | - | Connect cloud function to specified VPC connector. | +| - [vpcConnectorEgressSettings](#hosting_anyOf_i0_frameworksBackend_vpcConnectorEgressSettings ) | No | enum (of string) | No | - | Egress settings for VPC connector. | + +##### 9.1.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > concurrency` | | | | ------------ | -------- | @@ -3114,15 +2218,7 @@ Must be one of: **Description:** Number of requests a function can serve at once. -
-
- -
- - 9.1.3.2. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cors - - -
+##### 9.1.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cors` | | | | ------------ | ------------------- | @@ -3134,15 +2230,7 @@ If this is a `string` or `RegExp`, allows requests from domains that match the p If this is an `Array`, allows requests from domains matching at least one entry of the array. Defaults to true for {@link https.CallableFunction} and false otherwise. -
-
- -
- - 9.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > cpu - - -
+##### 9.1.3.3. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu` | | | | ------------------------- | ---------------- | @@ -3152,15 +2240,11 @@ Defaults to true for {@link https.CallableFunction} and false otherwise. **Description:** Fractional number of CPUs to allocate to a function. -
- | Any of(Option) | | ---------------------------------------------------------- | | [item 0](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i0) | | [item 1](#hosting_anyOf_i0_frameworksBackend_cpu_anyOf_i1) | -
- ###### 9.1.3.3.1. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 0` | | | @@ -3170,9 +2254,6 @@ Defaults to true for {@link https.CallableFunction} and false otherwise. Specific value: `"gcf_gen1"` -
-
- ###### 9.1.3.3.2. Property `root > hosting > anyOf > item 0 > frameworksBackend > cpu > anyOf > item 1` | | | @@ -3180,19 +2261,7 @@ Specific value: `"gcf_gen1"` | **Type** | `number` | | **Required** | No | -
- -
- -
-
- -
- - 9.1.3.4. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck - - -
+##### 9.1.3.4. Property `root > hosting > anyOf > item 0 > frameworksBackend > enforceAppCheck` | | | | ------------ | --------- | @@ -3201,15 +2270,7 @@ Specific value: `"gcf_gen1"` **Description:** Determines whether Firebase AppCheck is enforced. Defaults to false. -
-
- -
- - 9.1.3.5. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings - - -
+##### 9.1.3.5. Property `root > hosting > anyOf > item 0 > frameworksBackend > ingressSettings` | | | | ------------ | ------------------ | @@ -3223,15 +2284,7 @@ Must be one of: * "ALLOW_INTERNAL_AND_GCLB" * "ALLOW_INTERNAL_ONLY" -
-
- -
- - 9.1.3.6. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > invoker - - -
+##### 9.1.3.6. Property `root > hosting > anyOf > item 0 > frameworksBackend > invoker` | | | | ------------ | ------- | @@ -3242,15 +2295,7 @@ Must be one of: Specific value: `"public"` -
-
- -
- - 9.1.3.7. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > labels - - -
+##### 9.1.3.7. Property `root > hosting > anyOf > item 0 > frameworksBackend > labels` | | | | ------------------------- | ----------------------------------- | @@ -3261,15 +2306,7 @@ Specific value: `"public"` **Description:** User labels to set on the function. -
-
- -
- - 9.1.3.8. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > maxInstances - - -
+##### 9.1.3.8. Property `root > hosting > anyOf > item 0 > frameworksBackend > maxInstances` | | | | ------------ | -------- | @@ -3278,15 +2315,7 @@ Specific value: `"public"` **Description:** Max number of instances to be running in parallel. -
-
- -
- - 9.1.3.9. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > memory - - -
+##### 9.1.3.9. Property `root > hosting > anyOf > item 0 > frameworksBackend > memory` | | | | ------------ | ------------------ | @@ -3306,15 +2335,7 @@ Must be one of: * "512MiB" * "8GiB" -
-
- -
- - 9.1.3.10. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > minInstances - - -
+##### 9.1.3.10. Property `root > hosting > anyOf > item 0 > frameworksBackend > minInstances` | | | | ------------ | -------- | @@ -3323,15 +2344,7 @@ Must be one of: **Description:** Min number of actual instances to be running at a given time. -
-
- -
- - 9.1.3.11. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > omit - - -
+##### 9.1.3.11. Property `root > hosting > anyOf > item 0 > frameworksBackend > omit` | | | | ------------ | --------- | @@ -3340,15 +2353,7 @@ Must be one of: **Description:** If true, do not deploy or emulate this function. -
-
- -
- - 9.1.3.12. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges - - -
+##### 9.1.3.12. Property `root > hosting > anyOf > item 0 > frameworksBackend > preserveExternalChanges` | | | | ------------ | --------- | @@ -3357,15 +2362,7 @@ Must be one of: **Description:** Controls whether function configuration modified outside of function source is preserved. Defaults to false. -
-
- -
- - 9.1.3.13. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > region - - -
+##### 9.1.3.13. Property `root > hosting > anyOf > item 0 > frameworksBackend > region` | | | | ------------ | -------- | @@ -3374,15 +2371,7 @@ Must be one of: **Description:** HTTP functions can override global options and can specify multiple regions to deploy to. -
-
- -
- - 9.1.3.14. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > secrets - - -
+##### 9.1.3.14. Property `root > hosting > anyOf > item 0 > frameworksBackend > secrets` | | | | ------------ | ----------------- | @@ -3403,22 +2392,14 @@ Must be one of: | ------------------------------------------------------------------ | ----------- | | [secrets items](#hosting_anyOf_i0_frameworksBackend_secrets_items) | - | -###### 9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items +###### 9.1.3.14.1. root > hosting > anyOf > item 0 > frameworksBackend > secrets > secrets items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.3.15. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount - - -
+##### 9.1.3.15. Property `root > hosting > anyOf > item 0 > frameworksBackend > serviceAccount` | | | | ------------ | -------- | @@ -3427,15 +2408,7 @@ Must be one of: **Description:** Specific service account for the function to run as. -
-
- -
- - 9.1.3.16. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds - - -
+##### 9.1.3.16. Property `root > hosting > anyOf > item 0 > frameworksBackend > timeoutSeconds` | | | | ------------ | -------- | @@ -3445,15 +2418,7 @@ Must be one of: **Description:** Timeout for the function in seconds, possible values are 0 to 540. HTTPS functions can specify a higher timeout. -
-
- -
- - 9.1.3.17. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector - - -
+##### 9.1.3.17. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnector` | | | | ------------ | -------- | @@ -3462,15 +2427,7 @@ HTTPS functions can specify a higher timeout. **Description:** Connect cloud function to specified VPC connector. -
-
- -
- - 9.1.3.18. [Optional] Property root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings - - -
+##### 9.1.3.18. Property `root > hosting > anyOf > item 0 > frameworksBackend > vpcConnectorEgressSettings` | | | | ------------ | ------------------ | @@ -3483,18 +2440,7 @@ Must be one of: * "ALL_TRAFFIC" * "PRIVATE_RANGES_ONLY" -
-
- -
-
- -
- - 9.1.4. [Optional] Property root > hosting > anyOf > item 0 > headers - - -
+#### 9.1.4. Property `root > hosting > anyOf > item 0 > headers` | | | | ------------ | ------- | @@ -3515,7 +2461,7 @@ Must be one of: | ------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | -##### 9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders +##### 9.1.4.1. root > hosting > anyOf > item 0 > headers > HostingHeaders | | | | ------------------------- | ---------------------------- | @@ -3526,16 +2472,12 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -
- | Any of(Option) | | -------------------------------------------------- | | [item 0](#hosting_anyOf_i0_headers_items_anyOf_i0) | | [item 1](#hosting_anyOf_i0_headers_items_anyOf_i1) | | [item 2](#hosting_anyOf_i0_headers_items_anyOf_i2) | -
- ###### 9.1.4.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0` | | | @@ -3544,12 +2486,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [glob](#hosting_anyOf_i0_headers_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i0_headers ) | No | array of object | No | - | - | - -
+###### 9.1.4.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > glob` | | | | ------------ | -------- | @@ -3558,15 +2500,7 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.4.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers - - -
+###### 9.1.4.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers` | | | | ------------ | ----------------- | @@ -3585,7 +2519,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items) | - | -###### 9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items +###### 9.1.4.1.1.2.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items | | | | ------------------------- | ----------- | @@ -3593,12 +2527,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.1.2.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | +| + [key](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_key ) | No | string | No | - | The header to set. | +| + [value](#hosting_anyOf_i0_headers_items_anyOf_i0_headers_items_value ) | No | string | No | - | The value to set this header to. | - -
+###### 9.1.4.1.1.2.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > key` | | | | ------------ | -------- | @@ -3607,15 +2541,7 @@ Must be one of: **Description:** The header to set. -
-
- -
- - 9.1.4.1.1.2.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value - - -
+###### 9.1.4.1.1.2.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 0 > headers > headers items > value` | | | | ------------ | -------- | @@ -3624,15 +2550,6 @@ Must be one of: **Description:** The value to set this header to. -
-
- -
-
- -
-
- ###### 9.1.4.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1` | | | @@ -3641,12 +2558,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.2.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ---------------------------------------------- | +| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i1_headers ) | No | array of object | No | - | - | +| + [source](#hosting_anyOf_i0_headers_items_anyOf_i1_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.4.1.2.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers` | | | | ------------ | ----------------- | @@ -3665,7 +2582,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items) | - | -###### 9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items +###### 9.1.4.1.2.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items | | | | ------------------------- | ----------- | @@ -3673,12 +2590,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.2.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | +| + [key](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_key ) | No | string | No | - | The header to set. | +| + [value](#hosting_anyOf_i0_headers_items_anyOf_i1_headers_items_value ) | No | string | No | - | The value to set this header to. | - -
+###### 9.1.4.1.2.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > key` | | | | ------------ | -------- | @@ -3687,15 +2604,7 @@ Must be one of: **Description:** The header to set. -
-
- -
- - 9.1.4.1.2.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value - - -
+###### 9.1.4.1.2.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > headers > headers items > value` | | | | ------------ | -------- | @@ -3704,18 +2613,7 @@ Must be one of: **Description:** The value to set this header to. -
-
- -
-
- -
- - 9.1.4.1.2.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source - - -
+###### 9.1.4.1.2.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 1 > source` | | | | ------------ | -------- | @@ -3724,12 +2622,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.4.1.3. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2` | | | @@ -3738,12 +2630,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.3.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [headers](#hosting_anyOf_i0_headers_items_anyOf_i2_headers ) | No | array of object | No | - | - | +| + [regex](#hosting_anyOf_i0_headers_items_anyOf_i2_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.4.1.3.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers` | | | | ------------ | ----------------- | @@ -3762,7 +2654,7 @@ Must be one of: | ----------------------------------------------------------------------- | ----------- | | [headers items](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items) | - | -###### 9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items +###### 9.1.4.1.3.1.1. root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items | | | | ------------------------- | ----------- | @@ -3770,12 +2662,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.4.1.3.1.1.1. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------- | +| + [key](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_key ) | No | string | No | - | The header to set. | +| + [value](#hosting_anyOf_i0_headers_items_anyOf_i2_headers_items_value ) | No | string | No | - | The value to set this header to. | - -
+###### 9.1.4.1.3.1.1.1. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > key` | | | | ------------ | -------- | @@ -3784,15 +2676,7 @@ Must be one of: **Description:** The header to set. -
-
- -
- - 9.1.4.1.3.1.1.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value - - -
+###### 9.1.4.1.3.1.1.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > headers > headers items > value` | | | | ------------ | -------- | @@ -3801,18 +2685,7 @@ Must be one of: **Description:** The value to set this header to. -
-
- -
-
- -
- - 9.1.4.1.3.2. [Required] Property root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex - - -
+###### 9.1.4.1.3.2. Property `root > hosting > anyOf > item 0 > headers > headers items > anyOf > item 2 > regex` | | | | ------------ | -------- | @@ -3821,22 +2694,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- -
- -
-
- -
- - 9.1.5. [Optional] Property root > hosting > anyOf > item 0 > i18n - - -
+#### 9.1.5. Property `root > hosting > anyOf > item 0 > i18n` | | | | ------------------------- | ----------- | @@ -3848,12 +2706,11 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -
- - 9.1.5.1. [Required] Property root > hosting > anyOf > item 0 > i18n > root +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | +| + [root](#hosting_anyOf_i0_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | - -
+##### 9.1.5.1. Property `root > hosting > anyOf > item 0 > i18n > root` | | | | ------------ | -------- | @@ -3862,18 +2719,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -
-
- -
-
- -
- - 9.1.6. [Optional] Property root > hosting > anyOf > item 0 > ignore - - -
+#### 9.1.6. Property `root > hosting > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -3894,22 +2740,14 @@ for instructions on how to enable interntionalization for your site. | ---------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i0_ignore_items) | - | -##### 9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items +##### 9.1.6.1. root > hosting > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.7. [Optional] Property root > hosting > anyOf > item 0 > postdeploy - - -
+#### 9.1.7. Property `root > hosting > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -3919,15 +2757,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ----------------------------------------------- | | [item 0](#hosting_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 9.1.7.1. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -3947,16 +2781,13 @@ for instructions on how to enable interntionalization for your site. | ----------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 9.1.7.1.1. root > hosting > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 9.1.7.2. Property `root > hosting > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -3964,19 +2795,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.1.8. [Optional] Property root > hosting > anyOf > item 0 > predeploy - - -
+#### 9.1.8. Property `root > hosting > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -3986,15 +2805,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ---------------------------------------------- | | [item 0](#hosting_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 9.1.8.1. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -4014,16 +2829,13 @@ for instructions on how to enable interntionalization for your site. | ---------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 9.1.8.1.1. root > hosting > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 9.1.8.2. Property `root > hosting > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -4031,19 +2843,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.1.9. [Optional] Property root > hosting > anyOf > item 0 > public - - -
+#### 9.1.9. Property `root > hosting > anyOf > item 0 > public` | | | | ------------ | -------- | @@ -4052,15 +2852,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -
-
- -
- - 9.1.10. [Optional] Property root > hosting > anyOf > item 0 > redirects - - -
+#### 9.1.10. Property `root > hosting > anyOf > item 0 > redirects` | | | | ------------ | ------- | @@ -4081,7 +2873,7 @@ for instructions on how to enable interntionalization for your site. | ----------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -##### 9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects +##### 9.1.10.1. root > hosting > anyOf > item 0 > redirects > HostingRedirects | | | | ------------------------- | ------------------------------ | @@ -4092,16 +2884,12 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -
- | Any of(Option) | | ---------------------------------------------------- | | [item 0](#hosting_anyOf_i0_redirects_items_anyOf_i0) | | [item 1](#hosting_anyOf_i0_redirects_items_anyOf_i1) | | [item 2](#hosting_anyOf_i0_redirects_items_anyOf_i2) | -
- ###### 9.1.10.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0` | | | @@ -4110,12 +2898,13 @@ for instructions on how to enable interntionalization for your site. | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.10.1.1.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i0_destination ) | No | string | No | - | The destination to redirect to. | +| + [glob](#hosting_anyOf_i0_redirects_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i0_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | - -
+###### 9.1.10.1.1.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > destination` | | | | ------------ | -------- | @@ -4124,15 +2913,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The destination to redirect to. -
-
- -
- - 9.1.10.1.1.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob - - -
+###### 9.1.10.1.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > glob` | | | | ------------ | -------- | @@ -4141,15 +2922,7 @@ for instructions on how to enable interntionalization for your site. **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.10.1.1.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type - - -
+###### 9.1.10.1.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 0 > type` | | | | ------------ | ------------------- | @@ -4163,12 +2936,6 @@ Must be one of: * 301 * 302 -
-
- -
-
- ###### 9.1.10.1.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1` | | | @@ -4177,12 +2944,13 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.10.1.2.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i1_destination ) | No | string | No | - | The destination to redirect to. | +| + [source](#hosting_anyOf_i0_redirects_items_anyOf_i1_source ) | No | string | No | - | A file path that this setting should apply to. | +| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i1_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | - -
+###### 9.1.10.1.2.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > destination` | | | | ------------ | -------- | @@ -4191,15 +2959,7 @@ Must be one of: **Description:** The destination to redirect to. -
-
- -
- - 9.1.10.1.2.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source - - -
+###### 9.1.10.1.2.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > source` | | | | ------------ | -------- | @@ -4208,15 +2968,7 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
- - 9.1.10.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type - - -
+###### 9.1.10.1.2.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 1 > type` | | | | ------------ | ------------------- | @@ -4230,12 +2982,6 @@ Must be one of: * 301 * 302 -
-
- -
-
- ###### 9.1.10.1.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2` | | | @@ -4244,12 +2990,13 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.10.1.3.1. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ----------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_redirects_items_anyOf_i2_destination ) | No | string | No | - | The destination to redirect to. | +| + [regex](#hosting_anyOf_i0_redirects_items_anyOf_i2_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +| - [type](#hosting_anyOf_i0_redirects_items_anyOf_i2_type ) | No | enum (of integer) | No | - | The type of redirect.
Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) | - -
+###### 9.1.10.1.3.1. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > destination` | | | | ------------ | -------- | @@ -4258,15 +3005,7 @@ Must be one of: **Description:** The destination to redirect to. -
-
- -
- - 9.1.10.1.3.2. [Required] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex - - -
+###### 9.1.10.1.3.2. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > regex` | | | | ------------ | -------- | @@ -4275,15 +3014,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- - 9.1.10.1.3.3. [Optional] Property root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type - - -
+###### 9.1.10.1.3.3. Property `root > hosting > anyOf > item 0 > redirects > redirects items > anyOf > item 2 > type` | | | | ------------ | ------------------- | @@ -4293,26 +3024,11 @@ Must be one of: **Description:** The type of redirect. Use 301 for 'Moved Permanently' or 302 for 'Found' (Temporary Redirect) -Must be one of: -* 301 -* 302 - -
-
- -
- -
- -
-
- -
- - 9.1.11. [Optional] Property root > hosting > anyOf > item 0 > rewrites +Must be one of: +* 301 +* 302 - -
+#### 9.1.11. Property `root > hosting > anyOf > item 0 > rewrites` | | | | ------------ | ------- | @@ -4333,7 +3049,7 @@ Must be one of: | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -##### 9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites +##### 9.1.11.1. root > hosting > anyOf > item 0 > rewrites > HostingRewrites | | | | ------------------------- | ----------------------------- | @@ -4344,8 +3060,6 @@ Must be one of: **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -
- | Any of(Option) | | ----------------------------------------------------- | | [item 0](#hosting_anyOf_i0_rewrites_items_anyOf_i0) | @@ -4364,8 +3078,6 @@ Must be one of: | [item 13](#hosting_anyOf_i0_rewrites_items_anyOf_i13) | | [item 14](#hosting_anyOf_i0_rewrites_items_anyOf_i14) | -
- ###### 9.1.11.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0` | | | @@ -4374,27 +3086,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i0_destination ) | No | string | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i0_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | - -
+###### 9.1.11.1.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > destination` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.1.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob - - -
+###### 9.1.11.1.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 0 > glob` | | | | ------------ | -------- | @@ -4403,12 +3107,6 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1` | | | @@ -4417,27 +3115,20 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.2.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i1_function ) | No | string | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i1_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i1_region ) | No | string | No | - | - | - -
+###### 9.1.11.1.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > function` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.2.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob - - -
+###### 9.1.11.1.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > glob` | | | | ------------ | -------- | @@ -4446,27 +3137,13 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.11.1.2.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region - - -
+###### 9.1.11.1.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 1 > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- ###### 9.1.11.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2` | | | @@ -4475,12 +3152,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.3.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function ) | No | object | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i2_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | - -
+###### 9.1.11.1.3.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function` | | | | ------------------------- | ----------- | @@ -4488,12 +3165,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.3.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | +| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i2_function_region ) | No | string | No | - | The region of the Cloud Function to rewrite to. | - -
+###### 9.1.11.1.3.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > functionId` | | | | ------------ | -------- | @@ -4502,15 +3180,7 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -
-
- -
- - 9.1.11.1.3.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag - - -
+###### 9.1.11.1.3.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > pinTag` | | | | ------------ | --------- | @@ -4519,33 +3189,16 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -
-
- -
- - 9.1.11.1.3.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region - - -
+###### 9.1.11.1.3.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > function > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
+**Description:** The region of the Cloud Function to rewrite to. -
- - 9.1.11.1.3.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob - - -
+###### 9.1.11.1.3.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 2 > glob` | | | | ------------ | -------- | @@ -4554,12 +3207,6 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.4. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3` | | | @@ -4568,12 +3215,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.4.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i3_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | +| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run ) | No | object | No | - | - | - -
+###### 9.1.11.1.4.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > glob` | | | | ------------ | -------- | @@ -4582,15 +3229,7 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
- - 9.1.11.1.4.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run - - -
+###### 9.1.11.1.4.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run` | | | | ------------------------- | ----------- | @@ -4598,12 +3237,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.4.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_region ) | No | string | No | - | The region of the Cloud Run service to rewrite to. | +| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i3_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | - -
+###### 9.1.11.1.4.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > pinTag` | | | | ------------ | --------- | @@ -4612,30 +3252,16 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -
-
- -
- - 9.1.11.1.4.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region - - -
+###### 9.1.11.1.4.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.4.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId +**Description:** The region of the Cloud Run service to rewrite to. - -
+###### 9.1.11.1.4.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 3 > run > serviceId` | | | | ------------ | -------- | @@ -4644,15 +3270,6 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. -
-
- -
-
- -
-
- ###### 9.1.11.1.5. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4` | | | @@ -4661,27 +3278,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.5.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------- | +| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i4_dynamicLinks ) | No | boolean | No | - | - | +| + [glob](#hosting_anyOf_i0_rewrites_items_anyOf_i4_glob ) | No | string | No | - | A glob pattern describing the paths that this setting should apply to. | - -
+###### 9.1.11.1.5.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > dynamicLinks` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.5.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob - - -
+###### 9.1.11.1.5.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 4 > glob` | | | | ------------ | -------- | @@ -4690,12 +3299,6 @@ Must be one of: **Description:** A glob pattern describing the paths that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.6. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5` | | | @@ -4704,27 +3307,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.6.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i5_destination ) | No | string | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i5_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.6.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > destination` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.6.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source - - -
+###### 9.1.11.1.6.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 5 > source` | | | | ------------ | -------- | @@ -4733,12 +3328,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.7. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6` | | | @@ -4747,42 +3336,27 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.7.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i6_function ) | No | string | No | - | - | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i6_region ) | No | string | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i6_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.7.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > function` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.7.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region - - -
+###### 9.1.11.1.7.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.7.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source - - -
+###### 9.1.11.1.7.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 6 > source` | | | | ------------ | -------- | @@ -4791,12 +3365,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.8. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7` | | | @@ -4805,12 +3373,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.8.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function ) | No | object | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i7_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.8.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function` | | | | ------------------------- | ----------- | @@ -4818,12 +3386,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.8.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | +| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i7_function_region ) | No | string | No | - | The region of the Cloud Function to rewrite to. | - -
+###### 9.1.11.1.8.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > functionId` | | | | ------------ | -------- | @@ -4832,15 +3401,7 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -
-
- -
- - 9.1.11.1.8.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag - - -
+###### 9.1.11.1.8.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > pinTag` | | | | ------------ | --------- | @@ -4849,33 +3410,16 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -
-
- -
- - 9.1.11.1.8.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region - - -
+###### 9.1.11.1.8.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > function > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
+**Description:** The region of the Cloud Function to rewrite to. -
- - 9.1.11.1.8.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source - - -
+###### 9.1.11.1.8.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 7 > source` | | | | ------------ | -------- | @@ -4884,12 +3428,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.9. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8` | | | @@ -4898,12 +3436,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.9.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run ) | No | object | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i8_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.9.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run` | | | | ------------------------- | ----------- | @@ -4911,12 +3449,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.9.1.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_region ) | No | string | No | - | The region of the Cloud Run service to rewrite to. | +| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i8_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | - -
+###### 9.1.11.1.9.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > pinTag` | | | | ------------ | --------- | @@ -4925,30 +3464,16 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -
-
- -
- - 9.1.11.1.9.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region - - -
+###### 9.1.11.1.9.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.9.1.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId +**Description:** The region of the Cloud Run service to rewrite to. - -
+###### 9.1.11.1.9.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > run > serviceId` | | | | ------------ | -------- | @@ -4957,18 +3482,7 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. -
-
- -
-
- -
- - 9.1.11.1.9.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source - - -
+###### 9.1.11.1.9.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 8 > source` | | | | ------------ | -------- | @@ -4977,12 +3491,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.10. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9` | | | @@ -4991,27 +3499,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.10.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------- | +| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i9_dynamicLinks ) | No | boolean | No | - | - | +| + [source](#hosting_anyOf_i0_rewrites_items_anyOf_i9_source ) | No | string | No | - | A file path that this setting should apply to. | - -
+###### 9.1.11.1.10.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > dynamicLinks` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.10.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source - - -
+###### 9.1.11.1.10.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 9 > source` | | | | ------------ | -------- | @@ -5020,12 +3520,6 @@ Must be one of: **Description:** A file path that this setting should apply to. -
-
- -
-
- ###### 9.1.11.1.11. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10` | | | @@ -5034,27 +3528,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.11.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [destination](#hosting_anyOf_i0_rewrites_items_anyOf_i10_destination ) | No | string | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i10_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.11.1.11.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > destination` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.11.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex - - -
+###### 9.1.11.1.11.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 10 > regex` | | | | ------------ | -------- | @@ -5063,12 +3549,6 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
-
- ###### 9.1.11.1.12. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11` | | | @@ -5077,27 +3557,20 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.12.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i11_function ) | No | string | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i11_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i11_region ) | No | string | No | - | - | - -
+###### 9.1.11.1.12.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > function` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.12.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex - - -
+###### 9.1.11.1.12.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > regex` | | | | ------------ | -------- | @@ -5106,27 +3579,13 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- - 9.1.11.1.12.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region - - -
+###### 9.1.11.1.12.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 11 > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
- ###### 9.1.11.1.13. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12` | | | @@ -5135,12 +3594,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.13.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [function](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function ) | No | object | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i12_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.11.1.13.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function` | | | | ------------------------- | ----------- | @@ -5148,12 +3607,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.13.1.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------- | +| + [functionId](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_functionId ) | No | string | No | - | The ID of the Cloud Function to rewrite to. | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running version of the Cloud Function. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i12_function_region ) | No | string | No | - | The region of the Cloud Function to rewrite to. | - -
+###### 9.1.11.1.13.1.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > functionId` | | | | ------------ | -------- | @@ -5162,15 +3622,7 @@ Must be one of: **Description:** The ID of the Cloud Function to rewrite to. -
-
- -
- - 9.1.11.1.13.1.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag - - -
+###### 9.1.11.1.13.1.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > pinTag` | | | | ------------ | --------- | @@ -5179,33 +3631,16 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running version of the Cloud Function. -
-
- -
- - 9.1.11.1.13.1.3. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region - - -
+###### 9.1.11.1.13.1.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > function > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
-
+**Description:** The region of the Cloud Function to rewrite to. -
- - 9.1.11.1.13.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex - - -
+###### 9.1.11.1.13.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 12 > regex` | | | | ------------ | -------- | @@ -5214,12 +3649,6 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
-
- ###### 9.1.11.1.14. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13` | | | @@ -5228,12 +3657,12 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.14.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i13_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | +| + [run](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run ) | No | object | No | - | - | - -
+###### 9.1.11.1.14.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > regex` | | | | ------------ | -------- | @@ -5242,15 +3671,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- - 9.1.11.1.14.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run - - -
+###### 9.1.11.1.14.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run` | | | | ------------------------- | ----------- | @@ -5258,12 +3679,13 @@ Must be one of: | **Required** | Yes | | **Additional properties** | Not allowed | -
- - 9.1.11.1.14.2.1. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------- | +| - [pinTag](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_pinTag ) | No | boolean | No | - | If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. | +| - [region](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_region ) | No | string | No | - | The region of the Cloud Run service to rewrite to. | +| + [serviceId](#hosting_anyOf_i0_rewrites_items_anyOf_i13_run_serviceId ) | No | string | No | - | The ID of the Cloud Run service to rewrite to. | - -
+###### 9.1.11.1.14.2.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > pinTag` | | | | ------------ | --------- | @@ -5272,30 +3694,16 @@ Must be one of: **Description:** If true, the rewrite will be pinned to the currently running revision of the Cloud Run service. -
-
- -
- - 9.1.11.1.14.2.2. [Optional] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region - - -
+###### 9.1.11.1.14.2.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > region` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.1.11.1.14.2.3. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId +**Description:** The region of the Cloud Run service to rewrite to. - -
+###### 9.1.11.1.14.2.3. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 13 > run > serviceId` | | | | ------------ | -------- | @@ -5304,15 +3712,6 @@ Must be one of: **Description:** The ID of the Cloud Run service to rewrite to. -
-
- -
-
- -
-
- ###### 9.1.11.1.15. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14` | | | @@ -5321,27 +3720,19 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.1.11.1.15.1. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | --------------------------------------------------------------------------- | +| + [dynamicLinks](#hosting_anyOf_i0_rewrites_items_anyOf_i14_dynamicLinks ) | No | boolean | No | - | - | +| + [regex](#hosting_anyOf_i0_rewrites_items_anyOf_i14_regex ) | No | string | No | - | A regex pattern that matches the paths that this setting should apply to. * | - -
+###### 9.1.11.1.15.1. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > dynamicLinks` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | Yes | -
-
- -
- - 9.1.11.1.15.2. [Required] Property root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex - - -
+###### 9.1.11.1.15.2. Property `root > hosting > anyOf > item 0 > rewrites > rewrites items > anyOf > item 14 > regex` | | | | ------------ | -------- | @@ -5350,22 +3741,7 @@ Must be one of: **Description:** A regex pattern that matches the paths that this setting should apply to. * -
-
- -
- -
- -
-
- -
- - 9.1.12. [Optional] Property root > hosting > anyOf > item 0 > site - - -
+#### 9.1.12. Property `root > hosting > anyOf > item 0 > site` | | | | ------------ | -------- | @@ -5374,15 +3750,7 @@ Must be one of: **Description:** The site to deploy. -
-
- -
- - 9.1.13. [Optional] Property root > hosting > anyOf > item 0 > source - - -
+#### 9.1.13. Property `root > hosting > anyOf > item 0 > source` | | | | ------------ | -------- | @@ -5391,15 +3759,7 @@ Must be one of: **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -
-
- -
- - 9.1.14. [Optional] Property root > hosting > anyOf > item 0 > target - - -
+#### 9.1.14. Property `root > hosting > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -5409,27 +3769,13 @@ Must be one of: **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- - 9.1.15. [Optional] Property root > hosting > anyOf > item 0 > trailingSlash - - -
+#### 9.1.15. Property `root > hosting > anyOf > item 0 > trailingSlash` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
-
- ### 9.2. Property `root > hosting > anyOf > item 1` | | | @@ -5451,7 +3797,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------- | ----------- | | [item 1 items](#hosting_anyOf_i1_items) | - | -#### 9.2.1. root > hosting > anyOf > item 1 > item 1 items +#### 9.2.1. root > hosting > anyOf > item 1 > item 1 items | | | | ------------------------- | ---------------- | @@ -5459,15 +3805,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Any type allowed | -
- | Any of(Option) | | ------------------------------------------ | | [item 0](#hosting_anyOf_i1_items_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1) | -
- ##### 9.2.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0` | | | @@ -5476,12 +3818,25 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.2.1.1.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [appAssociation](#hosting_anyOf_i1_items_anyOf_i0_appAssociation ) | No | enum (of string) | No | - | - | +| - [cleanUrls](#hosting_anyOf_i1_items_anyOf_i0_cleanUrls ) | No | boolean | No | - | - | +| - [frameworksBackend](#hosting_anyOf_i1_items_anyOf_i0_frameworksBackend ) | No | object | No | Same as [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | Options for this sites web frameworks backend. | +| - [headers](#hosting_anyOf_i1_items_anyOf_i0_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | +| - [i18n](#hosting_anyOf_i1_items_anyOf_i0_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | +| - [ignore](#hosting_anyOf_i1_items_anyOf_i0_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | +| - [postdeploy](#hosting_anyOf_i1_items_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#hosting_anyOf_i1_items_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [public](#hosting_anyOf_i1_items_anyOf_i0_public ) | No | string | No | - | Whether this site should publically available. | +| - [redirects](#hosting_anyOf_i1_items_anyOf_i0_redirects ) | No | array | No | - | A list of redirects for this site. | +| - [rewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites ) | No | array | No | - | A list o rewrites for this site. | +| - [site](#hosting_anyOf_i1_items_anyOf_i0_site ) | No | string | No | - | The site to deploy | +| - [source](#hosting_anyOf_i1_items_anyOf_i0_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | +| + [target](#hosting_anyOf_i1_items_anyOf_i0_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +| - [trailingSlash](#hosting_anyOf_i1_items_anyOf_i0_trailingSlash ) | No | boolean | No | - | - | + +###### 9.2.1.1.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > appAssociation` | | | | ------------ | ------------------ | @@ -5492,30 +3847,14 @@ Must be one of: * "AUTO" * "NONE" -
-
- -
- - 9.2.1.1.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls - - -
+###### 9.2.1.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > cleanUrls` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- - 9.2.1.1.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend - - -
+###### 9.2.1.1.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > frameworksBackend` | | | | ------------------------- | -------------------------------------------------------- | @@ -5526,15 +3865,7 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -
-
- -
- - 9.2.1.1.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers - - -
+###### 9.2.1.1.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers` | | | | ------------ | ------- | @@ -5555,7 +3886,7 @@ Must be one of: | ---------------------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i0_headers_items) | Extra headers that should be sent when serving this path. | -###### 9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders +###### 9.2.1.1.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > headers > HostingHeaders | | | | ------------------------- | ----------------------------------------------------------------- | @@ -5566,15 +3897,7 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -
-
- -
- - 9.2.1.1.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n - - -
+###### 9.2.1.1.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n` | | | | ------------------------- | ----------- | @@ -5586,12 +3909,11 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -
- - 9.2.1.1.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | +| + [root](#hosting_anyOf_i1_items_anyOf_i0_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | - -
+###### 9.2.1.1.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > i18n > root` | | | | ------------ | -------- | @@ -5600,18 +3922,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -
-
- -
-
- -
- - 9.2.1.1.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore - - -
+###### 9.2.1.1.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore` | | | | ------------ | ----------------- | @@ -5632,22 +3943,14 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i1_items_anyOf_i0_ignore_items) | - | -###### 9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items +###### 9.2.1.1.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.2.1.1.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy - - -
+###### 9.2.1.1.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -5657,15 +3960,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i1) | -
- ###### 9.2.1.1.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -5685,16 +3984,13 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 9.2.1.1.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.1.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -5702,19 +3998,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.1.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy - - -
+###### 9.2.1.1.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -5724,15 +4008,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i1) | -
- ###### 9.2.1.1.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -5752,16 +4032,13 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 9.2.1.1.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.1.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -5769,19 +4046,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.1.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public - - -
+###### 9.2.1.1.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > public` | | | | ------------ | -------- | @@ -5790,15 +4055,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -
-
- -
- - 9.2.1.1.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects - - -
+###### 9.2.1.1.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects` | | | | ------------ | ------- | @@ -5819,7 +4076,7 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i0_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -###### 9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects +###### 9.2.1.1.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > redirects > HostingRedirects | | | | ------------------------- | --------------------------------------------------------------------- | @@ -5830,15 +4087,7 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -
-
- -
- - 9.2.1.1.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites - - -
+###### 9.2.1.1.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites` | | | | ------------ | ------- | @@ -5859,7 +4108,7 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i0_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -###### 9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites +###### 9.2.1.1.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > rewrites > HostingRewrites | | | | ------------------------- | ------------------------------------------------------------------- | @@ -5870,15 +4119,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -
-
- -
- - 9.2.1.1.12. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site - - -
+###### 9.2.1.1.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > site` | | | | ------------ | -------- | @@ -5887,15 +4128,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The site to deploy -
-
- -
- - 9.2.1.1.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source - - -
+###### 9.2.1.1.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > source` | | | | ------------ | -------- | @@ -5904,15 +4137,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -
-
- -
- - 9.2.1.1.14. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target - - -
+###### 9.2.1.1.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -5922,27 +4147,13 @@ for instructions on how to enable interntionalization for your site. **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- - 9.2.1.1.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash - - -
+###### 9.2.1.1.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 0 > trailingSlash` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
-
- ##### 9.2.1.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1` | | | @@ -5951,12 +4162,25 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 9.2.1.2.1. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation - - -
+| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [appAssociation](#hosting_anyOf_i1_items_anyOf_i1_appAssociation ) | No | enum (of string) | No | - | - | +| - [cleanUrls](#hosting_anyOf_i1_items_anyOf_i1_cleanUrls ) | No | boolean | No | - | - | +| - [frameworksBackend](#hosting_anyOf_i1_items_anyOf_i1_frameworksBackend ) | No | object | No | Same as [frameworksBackend](#hosting_anyOf_i0_frameworksBackend ) | Options for this sites web frameworks backend. | +| - [headers](#hosting_anyOf_i1_items_anyOf_i1_headers ) | No | array | No | - | A list of extra headers to send when serving specific paths on this site. | +| - [i18n](#hosting_anyOf_i1_items_anyOf_i1_i18n ) | No | object | No | - | Internationalization config for this site.
See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites
for instructions on how to enable interntionalization for your site. | +| - [ignore](#hosting_anyOf_i1_items_anyOf_i1_ignore ) | No | array of string | No | - | A list of paths or globs within the source directory that should not be included in the uploaded archive. | +| - [postdeploy](#hosting_anyOf_i1_items_anyOf_i1_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#hosting_anyOf_i1_items_anyOf_i1_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| - [public](#hosting_anyOf_i1_items_anyOf_i1_public ) | No | string | No | - | Whether this site should publically available. | +| - [redirects](#hosting_anyOf_i1_items_anyOf_i1_redirects ) | No | array | No | - | A list of redirects for this site. | +| - [rewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites ) | No | array | No | - | A list o rewrites for this site. | +| + [site](#hosting_anyOf_i1_items_anyOf_i1_site ) | No | string | No | - | The site to deploy | +| - [source](#hosting_anyOf_i1_items_anyOf_i1_source ) | No | string | No | - | Path to the directory containing this site's source code. This will be archived and uploaded during deployment. | +| - [target](#hosting_anyOf_i1_items_anyOf_i1_target ) | No | string | No | - | The deploy target to deploy.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | +| - [trailingSlash](#hosting_anyOf_i1_items_anyOf_i1_trailingSlash ) | No | boolean | No | - | - | + +###### 9.2.1.2.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > appAssociation` | | | | ------------ | ------------------ | @@ -5967,30 +4191,14 @@ Must be one of: * "AUTO" * "NONE" -
-
- -
- - 9.2.1.2.2. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls - - -
+###### 9.2.1.2.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > cleanUrls` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- - 9.2.1.2.3. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend - - -
+###### 9.2.1.2.3. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > frameworksBackend` | | | | ------------------------- | -------------------------------------------------------- | @@ -6001,15 +4209,7 @@ Must be one of: **Description:** Options for this sites web frameworks backend. -
-
- -
- - 9.2.1.2.4. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers - - -
+###### 9.2.1.2.4. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers` | | | | ------------ | ------- | @@ -6030,7 +4230,7 @@ Must be one of: | ---------------------------------------------------------------- | --------------------------------------------------------- | | [HostingHeaders](#hosting_anyOf_i1_items_anyOf_i1_headers_items) | Extra headers that should be sent when serving this path. | -###### 9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders +###### 9.2.1.2.4.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > headers > HostingHeaders | | | | ------------------------- | ----------------------------------------------------------------- | @@ -6041,15 +4241,7 @@ Must be one of: **Description:** Extra headers that should be sent when serving this path. -
-
- -
- - 9.2.1.2.5. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n - - -
+###### 9.2.1.2.5. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n` | | | | ------------------------- | ----------- | @@ -6061,12 +4253,11 @@ Must be one of: See https://firebase.google.com/docs/hosting/i18n-rewrites#set-up-i18n-rewrites for instructions on how to enable interntionalization for your site. -
- - 9.2.1.2.5.1. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------- | +| + [root](#hosting_anyOf_i1_items_anyOf_i1_i18n_root ) | No | string | No | - | The directory containing internationalization rewrites. | - -
+###### 9.2.1.2.5.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > i18n > root` | | | | ------------ | -------- | @@ -6075,18 +4266,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The directory containing internationalization rewrites. -
-
- -
-
- -
- - 9.2.1.2.6. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore - - -
+###### 9.2.1.2.6. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore` | | | | ------------ | ----------------- | @@ -6107,22 +4287,14 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------- | ----------- | | [ignore items](#hosting_anyOf_i1_items_anyOf_i1_ignore_items) | - | -###### 9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items +###### 9.2.1.2.6.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > ignore > ignore items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- -
- - 9.2.1.2.7. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy - - -
+###### 9.2.1.2.7. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy` | | | | ------------------------- | ---------------- | @@ -6132,15 +4304,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | -------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i1) | -
- ###### 9.2.1.2.7.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0` | | | @@ -6160,16 +4328,13 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_postdeploy_anyOf_i0_items) | - | -###### 9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items +###### 9.2.1.2.7.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.2.7.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > postdeploy > anyOf > item 1` | | | @@ -6177,19 +4342,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.2.8. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy - - -
+###### 9.2.1.2.8. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy` | | | | ------------------------- | ---------------- | @@ -6199,15 +4352,11 @@ for instructions on how to enable interntionalization for your site. **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------------------------- | | [item 0](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0) | | [item 1](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i1) | -
- ###### 9.2.1.2.8.1. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0` | | | @@ -6227,16 +4376,13 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------------- | ----------- | | [item 0 items](#hosting_anyOf_i1_items_anyOf_i1_predeploy_anyOf_i0_items) | - | -###### 9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items +###### 9.2.1.2.8.1.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 9.2.1.2.8.2. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > predeploy > anyOf > item 1` | | | @@ -6244,19 +4390,7 @@ for instructions on how to enable interntionalization for your site. | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 9.2.1.2.9. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public - - -
+###### 9.2.1.2.9. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > public` | | | | ------------ | -------- | @@ -6265,15 +4399,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Whether this site should publically available. -
-
- -
- - 9.2.1.2.10. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects - - -
+###### 9.2.1.2.10. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects` | | | | ------------ | ------- | @@ -6294,7 +4420,7 @@ for instructions on how to enable interntionalization for your site. | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [HostingRedirects](#hosting_anyOf_i1_items_anyOf_i1_redirects_items) | URL redirects for a hosting site. Use these to prevent broken links when moving pages. | -###### 9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects +###### 9.2.1.2.10.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > redirects > HostingRedirects | | | | ------------------------- | --------------------------------------------------------------------- | @@ -6305,15 +4431,7 @@ for instructions on how to enable interntionalization for your site. **Description:** URL redirects for a hosting site. Use these to prevent broken links when moving pages. -
-
- -
- - 9.2.1.2.11. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites - - -
+###### 9.2.1.2.11. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites` | | | | ------------ | ------- | @@ -6334,7 +4452,7 @@ for instructions on how to enable interntionalization for your site. | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | [HostingRewrites](#hosting_anyOf_i1_items_anyOf_i1_rewrites_items) | Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. | -###### 9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites +###### 9.2.1.2.11.1. root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > rewrites > HostingRewrites | | | | ------------------------- | ------------------------------------------------------------------- | @@ -6345,15 +4463,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Defines a Hosting rewrite. Rewrites allow you to redirect URLs to a different path, Cloud function or Cloud Run service. -
-
- -
- - 9.2.1.2.12. [Required] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site - - -
+###### 9.2.1.2.12. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > site` | | | | ------------ | -------- | @@ -6362,15 +4472,7 @@ for instructions on how to enable interntionalization for your site. **Description:** The site to deploy -
-
- -
- - 9.2.1.2.13. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source - - -
+###### 9.2.1.2.13. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > source` | | | | ------------ | -------- | @@ -6379,15 +4481,7 @@ for instructions on how to enable interntionalization for your site. **Description:** Path to the directory containing this site's source code. This will be archived and uploaded during deployment. -
-
- -
- - 9.2.1.2.14. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target - - -
+###### 9.2.1.2.14. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > target` | | | | ------------ | -------- | @@ -6397,41 +4491,14 @@ for instructions on how to enable interntionalization for your site. **Description:** The deploy target to deploy. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- - 9.2.1.2.15. [Optional] Property root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash - - -
+###### 9.2.1.2.15. Property `root > hosting > anyOf > item 1 > item 1 items > anyOf > item 1 > trailingSlash` | | | | ------------ | --------- | | **Type** | `boolean` | | **Required** | No | -
-
- -
- -
- -
- -
- -
-
- -
- - 10. [Optional] Property root > remoteconfig - - -
+## 10. Property `root > remoteconfig` | | | | ------------------------- | -------------------------------- | @@ -6442,12 +4509,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Remote Config template(s) used by this project. -
- - 10.1. [Optional] Property root > remoteconfig > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------------------------------------------------------------------- | +| - [postdeploy](#remoteconfig_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#remoteconfig_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [template](#remoteconfig_template ) | No | string | No | - | A path to a CJSON file containing a Remote Config template. | - -
+### 10.1. Property `root > remoteconfig > postdeploy` | | | | ------------------------- | ---------------- | @@ -6457,15 +4525,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ------------------------------------------- | | [item 0](#remoteconfig_postdeploy_anyOf_i0) | | [item 1](#remoteconfig_postdeploy_anyOf_i1) | -
- #### 10.1.1. Property `root > remoteconfig > postdeploy > anyOf > item 0` | | | @@ -6485,16 +4549,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------- | ----------- | | [item 0 items](#remoteconfig_postdeploy_anyOf_i0_items) | - | -##### 10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items +##### 10.1.1.1. root > remoteconfig > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- #### 10.1.2. Property `root > remoteconfig > postdeploy > anyOf > item 1` | | | @@ -6502,19 +4563,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 10.2. [Optional] Property root > remoteconfig > predeploy - - -
+### 10.2. Property `root > remoteconfig > predeploy` | | | | ------------------------- | ---------------- | @@ -6524,15 +4573,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ------------------------------------------ | | [item 0](#remoteconfig_predeploy_anyOf_i0) | | [item 1](#remoteconfig_predeploy_anyOf_i1) | -
- #### 10.2.1. Property `root > remoteconfig > predeploy > anyOf > item 0` | | | @@ -6552,16 +4597,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ------------------------------------------------------ | ----------- | | [item 0 items](#remoteconfig_predeploy_anyOf_i0_items) | - | -##### 10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items +##### 10.2.1.1. root > remoteconfig > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- #### 10.2.2. Property `root > remoteconfig > predeploy > anyOf > item 1` | | | @@ -6569,19 +4611,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 10.3. [Required] Property root > remoteconfig > template - - -
+### 10.3. Property `root > remoteconfig > template` | | | | ------------ | -------- | @@ -6590,18 +4620,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A path to a CJSON file containing a Remote Config template. -
-
- -
-
- -
- - 11. [Optional] Property root > storage - - -
+## 11. Property `root > storage` | | | | ------------------------- | ---------------- | @@ -6611,15 +4630,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Firebase Storage rules that should be deployed or emulated. -
- | Any of(Option) | | ---------------------------------- | | [StorageSingle](#storage_anyOf_i0) | | [item 1](#storage_anyOf_i1) | -
- ### 11.1. Property `root > storage > anyOf > StorageSingle` | | | @@ -6631,12 +4646,14 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Deployment options for a single Firebase storage bucket. -
- - 11.1.1. [Optional] Property root > storage > anyOf > item 0 > postdeploy +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| - [postdeploy](#storage_anyOf_i0_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#storage_anyOf_i0_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#storage_anyOf_i0_rules ) | No | string | No | - | Path to the rules files for this Firebase Storage bucket. | +| - [target](#storage_anyOf_i0_target ) | No | string | No | - | The deploy target to these Storage rules to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+#### 11.1.1. Property `root > storage > anyOf > item 0 > postdeploy` | | | | ------------------------- | ---------------- | @@ -6646,15 +4663,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ----------------------------------------------- | | [item 0](#storage_anyOf_i0_postdeploy_anyOf_i0) | | [item 1](#storage_anyOf_i0_postdeploy_anyOf_i1) | -
- ##### 11.1.1.1. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 0` | | | @@ -6674,16 +4687,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ----------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i0_postdeploy_anyOf_i0_items) | - | -###### 11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items +###### 11.1.1.1.1. root > storage > anyOf > item 0 > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 11.1.1.2. Property `root > storage > anyOf > item 0 > postdeploy > anyOf > item 1` | | | @@ -6691,19 +4701,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.1.2. [Optional] Property root > storage > anyOf > item 0 > predeploy - - -
+#### 11.1.2. Property `root > storage > anyOf > item 0 > predeploy` | | | | ------------------------- | ---------------- | @@ -6713,15 +4711,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ---------------------------------------------- | | [item 0](#storage_anyOf_i0_predeploy_anyOf_i0) | | [item 1](#storage_anyOf_i0_predeploy_anyOf_i1) | -
- ##### 11.1.2.1. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 0` | | | @@ -6741,16 +4735,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i0_predeploy_anyOf_i0_items) | - | -###### 11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items +###### 11.1.2.1.1. root > storage > anyOf > item 0 > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ##### 11.1.2.2. Property `root > storage > anyOf > item 0 > predeploy > anyOf > item 1` | | | @@ -6758,19 +4749,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.1.3. [Required] Property root > storage > anyOf > item 0 > rules - - -
+#### 11.1.3. Property `root > storage > anyOf > item 0 > rules` | | | | ------------ | -------- | @@ -6779,15 +4758,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the rules files for this Firebase Storage bucket. -
-
- -
- - 11.1.4. [Optional] Property root > storage > anyOf > item 0 > target - - -
+#### 11.1.4. Property `root > storage > anyOf > item 0 > target` | | | | ------------ | -------- | @@ -6797,12 +4768,6 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target to these Storage rules to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
-
- ### 11.2. Property `root > storage > anyOf > item 1` | | | @@ -6824,7 +4789,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | --------------------------------------- | ----------- | | [item 1 items](#storage_anyOf_i1_items) | - | -#### 11.2.1. root > storage > anyOf > item 1 > item 1 items +#### 11.2.1. root > storage > anyOf > item 1 > item 1 items | | | | ------------------------- | ----------- | @@ -6832,12 +4797,15 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Required** | No | | **Additional properties** | Not allowed | -
- - 11.2.1.1. [Required] Property root > storage > anyOf > item 1 > item 1 items > bucket +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| + [bucket](#storage_anyOf_i1_items_bucket ) | No | string | No | - | The Firebase Storage bucket that this config is for. | +| - [postdeploy](#storage_anyOf_i1_items_postdeploy ) | No | Combination | No | - | A script or list of scripts that will be ran after this product is deployed. | +| - [predeploy](#storage_anyOf_i1_items_predeploy ) | No | Combination | No | - | A script or list of scripts that will be ran before this product is deployed. | +| + [rules](#storage_anyOf_i1_items_rules ) | No | string | No | - | Path to the rules files for this Firebase Storage bucket. | +| - [target](#storage_anyOf_i1_items_target ) | No | string | No | - | The deploy target to these Storage rules to.
See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. | - -
+##### 11.2.1.1. Property `root > storage > anyOf > item 1 > item 1 items > bucket` | | | | ------------ | -------- | @@ -6846,15 +4814,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The Firebase Storage bucket that this config is for. -
-
- -
- - 11.2.1.2. [Optional] Property root > storage > anyOf > item 1 > item 1 items > postdeploy - - -
+##### 11.2.1.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy` | | | | ------------------------- | ---------------- | @@ -6864,15 +4824,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran after this product is deployed. -
- | Any of(Option) | | ----------------------------------------------------- | | [item 0](#storage_anyOf_i1_items_postdeploy_anyOf_i0) | | [item 1](#storage_anyOf_i1_items_postdeploy_anyOf_i1) | -
- ###### 11.2.1.2.1. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0` | | | @@ -6892,16 +4848,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ----------------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i1_items_postdeploy_anyOf_i0_items) | - | -###### 11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items +###### 11.2.1.2.1.1. root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 11.2.1.2.2. Property `root > storage > anyOf > item 1 > item 1 items > postdeploy > anyOf > item 1` | | | @@ -6909,19 +4862,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.2.1.3. [Optional] Property root > storage > anyOf > item 1 > item 1 items > predeploy - - -
+##### 11.2.1.3. Property `root > storage > anyOf > item 1 > item 1 items > predeploy` | | | | ------------------------- | ---------------- | @@ -6931,15 +4872,11 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** A script or list of scripts that will be ran before this product is deployed. -
- | Any of(Option) | | ---------------------------------------------------- | | [item 0](#storage_anyOf_i1_items_predeploy_anyOf_i0) | | [item 1](#storage_anyOf_i1_items_predeploy_anyOf_i1) | -
- ###### 11.2.1.3.1. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0` | | | @@ -6959,16 +4896,13 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | ---------------------------------------------------------------- | ----------- | | [item 0 items](#storage_anyOf_i1_items_predeploy_anyOf_i0_items) | - | -###### 11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items +###### 11.2.1.3.1.1. root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 0 > item 0 items | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | -
-
- ###### 11.2.1.3.2. Property `root > storage > anyOf > item 1 > item 1 items > predeploy > anyOf > item 1` | | | @@ -6976,19 +4910,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ | **Type** | `string` | | **Required** | No | -
- -
- -
-
- -
- - 11.2.1.4. [Required] Property root > storage > anyOf > item 1 > item 1 items > rules - - -
+##### 11.2.1.4. Property `root > storage > anyOf > item 1 > item 1 items > rules` | | | | ------------ | -------- | @@ -6997,15 +4919,7 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** Path to the rules files for this Firebase Storage bucket. -
-
- -
- - 11.2.1.5. [Optional] Property root > storage > anyOf > item 1 > item 1 items > target - - -
+##### 11.2.1.5. Property `root > storage > anyOf > item 1 > item 1 items > target` | | | | ------------ | -------- | @@ -7015,15 +4929,5 @@ See https://firebase.google.com/docs/cli/targets to learn more about deploy targ **Description:** The deploy target to these Storage rules to. See https://firebase.google.com/docs/cli/targets to learn more about deploy targets. -
-
- -
- -
- -
-
- ---------------------------------------------------------------------------------------------------------------------------- -Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:11:22 -0700 \ No newline at end of file +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-17 at 07:38:46 -0700 diff --git a/schema/docs/index.md b/schema/docs/index.md new file mode 100644 index 00000000000..a6ffb51eef9 --- /dev/null +++ b/schema/docs/index.md @@ -0,0 +1,11 @@ +# Index +- [connector-yaml.html](connector-yaml.html) +- [connector-yaml](connector-yaml.md) +- [dataconnect-yaml.html](dataconnect-yaml.html) +- [dataconnect-yaml](dataconnect-yaml.md) +- [extension-yaml.html](extension-yaml.html) +- [extension-yaml](extension-yaml.md) +- [firebase-config.html](firebase-config.html) +- [firebase-config](firebase-config.md) +- [schema_doc.css](schema_doc.css) +- [schema_doc.min.js](schema_doc.min.js) diff --git a/scripts/docs-gen/jsfh-config.yaml b/scripts/docs-gen/jsfh-config.yaml index a9552b42913..f78051b50cb 100644 --- a/scripts/docs-gen/jsfh-config.yaml +++ b/scripts/docs-gen/jsfh-config.yaml @@ -1,2 +1,2 @@ -template_name: js +template_name: md show_toc: false \ No newline at end of file