schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
localazy.json | $schema | Schema definition for Localazy CLI configuration file. | {"type": "string", "default": "https://raw.githubusercontent.com/localazy/cli-schema/master/localazy.json"} |
localazy.json | writeKey | Your project's write key. It can be found in Settings -> Access keys. | {"type": "string"} |
localazy.json | readKey | Your project's read key. It can be found in Settings -> Access keys. | {"type": "string"} |
localazy.json | branch | The branch to perform the operation on. If not specified, the operation is performed on the project corresponding to write/read key. | {"type": "string"} |
localazy.json | community | Define community settings for sharing your configuration with other users. https://localazy.com/docs/cli/community-sharing | {"type": "object", "properties": {"author": {"type": "string"}, "email": {"type": "string"}, "company": {"type": "string"}, "website": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}} |
localazy.json | author | The name of the author of the script. | {"type": "string"} |
localazy.json | email | The email of the author of the script. It's not available publicly. | {"type": "string"} |
localazy.json | company | Company name if applicable. | {"type": "string"} |
localazy.json | website | Website name if applicable. | {"type": "string"} |
localazy.json | tags | A set of tags to help other users find your script. Please tag your technology stack, framework, library, programming language, etc. | {"type": "array", "items": {"type": "string"}} |
localazy.json | description | The description of the script. Please describe what the script does and how it works. | {"type": "string"} |
localazy.json | transformations | The transformations property allows defining rules for string transformations. Using transformations, you can, e.g., obtain locale code from its file path or build the specific path where to write translated files. https://localazy.com/docs/cli/transformations | {"type": ["array", "object"], "anyOf": [{"type": "array", "items": {}}, {}]} |
localazy.json | upload | The upload section defines how to collect files that you want to upload to the Localazy platform for localization and what metadata to include. It also defines how to process uploaded data. https://localazy.com/docs/cli/upload-reference | {"type": "object", "properties": {"deprecateMissing": {"type": "boolean", "default": false}, "deprecate": {"type": "string", "default": "none", "enum": ["file", "project", "none"]}, "importAsNew": {"type": "boolean", "default": false}, "allowDuplicateKeys": {"type": "boolean", "default": false}, "skipFailedAutodetection": {"type": "boolean", "default": true}, "filterSource": {"type": "boolean"}, "forceCurrent": {"type": "boolean", "default": false}, "appVersion": {"type": "number", "default": 0}, "type": {"type": "string", "enum": ["android", "json", "arb", "ios-strings", "ios-plist", "ios-stringsdict", "xliff", "resx", "yaml", "po", "pot", "json5", "hjson", "js", "properties", "ini", "php", "qt-ts", "text", "csv", "neon", "toml", "excel", "ods", "srt"]}, "folder": {"type": "string"}, "features": {"type": ["string", "array"], "anyOf": [{}, {"type": "array", "items": {}}]}, "keySeparator": {"type": "string", "default": "."}, "includeKeys": {"type": "array", "items": {"type": "string"}}, "excludeKeys": {"type": "array", "items": {"type": "string"}}, "files": {"type": ["string", "array", "object"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}, {}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}} |
localazy.json | deprecateMissing | Tells the server to deprecate any phrase missing in this upload batch. Deprecated phrases are still available but are not visible to translators. | {"type": "boolean", "default": false} |
localazy.json | deprecate | Tells the server to deprecate any phrase missing in this upload batch. Deprecated phrases are still available but are not visible to translators. | {"type": "string", "default": "none", "enum": ["file", "project", "none"]} |
localazy.json | importAsNew | Tells the server to import new phrases as unverified. Unverified phrases need to go through the review process. This option allows you to check translations using our unique review process if you are not sure of their quality. This option doesn’t apply to the source language. | {"type": "boolean", "default": false} |
localazy.json | allowDuplicateKeys | By default, you can have phrases with the same key in different files. For specific situations like using libraries and string overriding, it’s necessary to disable this option. You can find more on this topic in 'Modules, libraries, product flavors' article. | {"type": "boolean", "default": false} |
localazy.json | skipFailedAutodetection | When set to true files that use auto-detection are skipped if the auto-detection is not possible. When set to false an exception is raised. | {"type": "boolean", "default": true} |
localazy.json | filterSource | When set to true, strings that are the same as in the source langauge are not imported. This is important for platforms like iOS where localizable files contain the source phrase where the translation is not available. This option doesn’t apply to the source language. | {"type": "boolean"} |
localazy.json | forceCurrent | Tells the server to promote changes in translated files as approved and current translations for phrases that are already translated. If set to false, such changes go to the review process. | {"type": "boolean", "default": false} |
localazy.json | appVersion | Tells the server the version of the app in which the phrases where deprecated. It only makes sense with deprecateMissing switched to true. It allows for automatic versioning of deprecated phrases. This option can be provided on the command-line with -v option. | {"type": "number", "default": 0} |
localazy.json | type | Type of files you are about to upload. You can also define the type separately for each file. For more info about supported file formats check out the documentation. | {"type": "string", "enum": ["android", "json", "arb", "ios-strings", "ios-plist", "ios-stringsdict", "xliff", "resx", "yaml", "po", "pot", "json5", "hjson", "js", "properties", "ini", "php", "qt-ts", "text", "csv", "neon", "toml", "excel", "ods", "srt"]} |
localazy.json | folder | The base folder all operations are relative to. It can be relative or absolute path. | {"type": "string"} |
localazy.json | features | The list of features (eg. how to parse plurals) to enable for the given type. See the list of supported file formats in documentation for more information. https://localazy.com/docs/cli/upload-reference#supported-file-formats | {"type": ["string", "array"], "anyOf": [{}, {"type": "array", "items": {}}]} |
localazy.json | keySeparator | The separator used for building structured keys for includeKeys and excludeKeys. For more details: https://localazy.com/docs/cli/excluding-string-keys | {"type": "string", "default": "."} |
localazy.json | includeKeys | A list of rules for determining keys to include. For more details: https://localazy.com/docs/cli/excluding-string-keys | {"type": "array", "items": {"type": "string"}} |
localazy.json | excludeKeys | A list of rules for determining keys to exclude. For more details: https://localazy.com/docs/cli/excluding-string-keys | {"type": "array", "items": {"type": "string"}} |
localazy.json | files | The files contains a list of rules for collecting files for upload. You can include files by their exact path or by using standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators). You can control files that you want to upload with exclusion rules and conditions. | {"type": ["string", "array", "object"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}, {}]} |
localazy.json | conversion | The conversion property describes how to convert localizable files between different formats. https://localazy.com/docs/cli/format-conversions#full-configuration | {"type": "object", "properties": {"folder": {"type": "string"}, "excludedLangs": {"type": "array", "items": {"type": "string"}}, "actions": {"type": ["array", "object"], "anyOf": [{"type": "array", "items": {}}, {}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}} |
localazy.json | folder | The base folder all operations are relative to. It can be relative or absolute path. | {"type": "string"} |
localazy.json | excludedLangs | The list of languages to exclude from processing. | {"type": "array", "items": {"type": "string"}} |
localazy.json | actions | Define the conversion rules. | {"type": ["array", "object"], "anyOf": [{"type": "array", "items": {}}, {}]} |
localazy.json | download | The download property describes how to process translated files and where to write them. https://localazy.com/docs/cli/download-reference | {"type": "object", "properties": {"includeSourceLang": {"type": "boolean", "default": false}, "folder": {"type": "string"}, "metadataFileJson": {"type": "string"}, "metadataFileJs": {"type": "string"}, "metadataFileTs": {"type": "string"}, "langAliases": {"type": "object", "additionalProperties": true}, "langExpansions": {"type": "object", "additionalProperties": true}, "excludedLangs": {"type": ["array", "string"], "anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "files": {"type": ["string", "array", "object"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}, {}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}} |
localazy.json | includeSourceLang | By default, the source language is not downloaded. Set it to true to include source files as well. | {"type": "boolean", "default": false} |
localazy.json | folder | Base folder for the download action. It can be relative or absolute path. | {"type": "string"} |
localazy.json | metadataFileJson | Path where JSON language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file | {"type": "string"} |
localazy.json | metadataFileJs | Path where JavaScript language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file | {"type": "string"} |
localazy.json | metadataFileTs | Path where TypeScript language metadata file should be downloaded. https://localazy.com/docs/cli/metadata-file | {"type": "string"} |
localazy.json | langAliases | Maps languages to different ones. | {"type": "object", "additionalProperties": true} |
localazy.json | langExpansions | Adds additional languages to output; the same file will be saved several time. | {"type": "object", "additionalProperties": true} |
localazy.json | excludedLangs | The list of languages to exclude from processing. | {"type": ["array", "string"], "anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]} |
localazy.json | files | The rules to apply to all translated files. It can be either array object or a pattern string. | {"type": ["string", "array", "object"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}, {}]} |
localazy.json | name | The name of the newly created variable. It will be accessible as ${name}. https://localazy.com/docs/cli/variables | {"type": "string"} |
localazy.json | source | The source of the variable. Usually, it's a string consisting of other variables. https://localazy.com/docs/cli/variables | {"type": "string"} |
localazy.json | operations | The operations to perform on the source string to get the new variable. https://localazy.com/docs/cli/transformations#operations | {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]} |
localazy.json | type | Type of files you are about to upload. For more info about supported file formats check out the documentation. https://localazy.com/docs/cli/upload-reference | {"type": "string", "enum": ["android", "json", "arb", "ios-strings", "ios-plist", "ios-stringsdict", "xliff", "resx", "yaml", "po", "pot", "json5", "hjson", "js", "properties", "ini", "php", "qt-ts", "text", "csv", "neon", "toml", "excel", "ods", "srt"]} |
localazy.json | features | The list of features (eg. how to parse plurals) to enable for the given type. See the list of supported file formats in documentation for more information. https://localazy.com/docs/cli/upload-reference#supported-file-formats | {"type": ["string", "array"], "anyOf": [{}, {"type": "array", "items": {}}]} |
localazy.json | lang | The language of the file being uploaded (format: ll-Scrp-RR). Special default value inherited from the project’s base language. | {"type": "string", "default": "inherited"} |
localazy.json | group | Allows to assign files to groups and run their rules separately. | {"type": "string"} |
localazy.json | buildType | The custom build type for the file. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#build-type | {"type": "string"} |
localazy.json | productFlavors | The custom product flavors for the file. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#product-flavors | {"type": "string"} |
localazy.json | module | The module the file belongs to. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#module | {"type": "string"} |
localazy.json | library | The library the file belongs to. See Modules, libraries, flavors for more details. https://localazy.com/docs/cli/modules-libraries-product-flavors#library | {"type": "string"} |
localazy.json | path | The path to be used for upload. | {"type": "string"} |
localazy.json | file | The file name to be used for upload. | {"type": "string"} |
localazy.json | pattern | The pattern to use for collecting files. Standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators) are supported. | {"type": "string"} |
localazy.json | excludes | The list of patterns used for excluding files. Standard path wildcards ? (single character), * (anything except path separator), ** (anything including path separators) are supported. | {"type": "array", "items": {"type": "string"}} |
localazy.json | conditions | With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions | {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}]} |
localazy.json | group | Allows to assign files to groups and run their rules separately. | {"type": "string"} |
localazy.json | conditions | With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions | {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}]} |
localazy.json | keySeparator | The separator used for building structured keys for includeKeys and excludeKeys. For more details: https://localazy.com/docs/cli/excluding-string-keys | {"type": "string", "default": "."} |
localazy.json | includeKeys | A list of rules for determining keys to include. For more details: https://localazy.com/docs/cli/excluding-string-keys | {"type": "array", "items": {"type": "string"}} |
localazy.json | excludeKeys | A list of rules for determining keys to exclude. For more details: https://localazy.com/docs/cli/excluding-string-keys | {"type": "array", "items": {"type": "string"}} |
localazy.json | replacements | Define rules for text changes and placeholder replacements. | {"type": "object", "additionalProperties": true} |
localazy.json | langAliases | Maps languages to different ones. | {"type": "object", "additionalProperties": true} |
localazy.json | langExpansions | Adds additional languages to output; the same file will be saved several time. | {"type": "object", "additionalProperties": true} |
localazy.json | stop | If true, no more rules are processed for the given file. Only makes sense if more output rules are defined. By default, the first matching rule stops processing for the file. | {"type": "boolean", "default": false} |
localazy.json | changeExtension | If defined, change the extension of the output file. Applied to the final output after resolving all variables. | {"type": "string"} |
localazy.json | output | The pattern for generating output path and file. Use variables to build the pattern. https://localazy.com/docs/cli/variables | {"type": "string"} |
localazy.json | type | The type of the conversion to be performed with files. See docs for available types and their parameters. https://localazy.com/docs/cli/format-conversions#available-conversions | {"type": "string", "enum": ["android", "arb", "csv", "csv-multilingual", "excel", "excel-multilingual", "ini", "ini-multilingual", "ios-strings", "ios-stringsdict", "json", "json-mozilla", "json-multilingual", "mo", "neon", "neon-multilingual", "ods", "ods-multilingual", "php", "php-multilingual", "po", "toml", "toml-multilingual", "yaml", "yaml-multilingual", "yaml-rails"]} |
localazy.json | arrayType | If the type supports more formats for string arrays, you can select the desired one with this parameter. | {"type": "string", "enum": ["array", "array_br"]} |
localazy.json | pluralType | If the type supports more formats for plurals, you can select the desired one with this parameter. | {"type": "string", "enum": ["plural_postfix_br", "plural_postfix_sd", "plural_postfix_dd", "plural_postfix_us", "plural_postfix_cc", "plural_i18next", "plural_object", "plural_icu", "plural_array"]} |
localazy.json | forceArrayType | If the conversion is made between types that support the same format for string arrays, the format is retained unless you explicitly set this parameter to true to force change. | {"type": "boolean", "default": false} |
localazy.json | forcePluralType | If the conversion is made between types that support the same format for plurals, the format is retained unless you explicitly set this parameter to true to force change. | {"type": "boolean", "default": false} |
localazy.json | filterStrings | If the conversion type allows filtering, you can enable this option to filter strings out of the output file. | {"type": "boolean"} |
localazy.json | filterArrays | If the conversion type allows filtering, you can enable this option to filter string arrays out of the output file. | {"type": "boolean"} |
localazy.json | filterPlurals | If the conversion type allows filtering, you can enable this option to filter plurals out of the output file. | {"type": "boolean"} |
localazy.json | params | Some of the conversion types support additional parameters. See documentation for details. | {"type": "object", "additionalProperties": true} |
localazy.json | group | Allows to assign files to groups and run their rules separately. | {"type": "string"} |
localazy.json | conditions | With conditions, you can introduce complex logic for processing files when they are downloaded. See documentation for options. https://localazy.com/docs/cli/conditions | {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}]} |
localazy.json | stop | If true, no more rules are processed for the given file. Only makes sense if more output rules are defined. By default, the first matching rule stops processing for the file. | {"type": "boolean", "default": false} |
localazy.json | output | The pattern for generating output path and file. Use variables to build the pattern. | {"type": "string"} |
mongodb-atlas-search-index-definition.json | name | Name of the custom analyzer.
Names must be unique within an index, and may not start with any of the following strings:
- lucene.
- builtin.
- mongodb. | {"type": "string", "pattern": "^(?!^lucene\\.|builtin\\.|mongodb\\.).*"} |
mongodb-atlas-search-index-definition.json | charFilters | Array containing zero or more character filters. | {"type": "array", "items": {}} |
mongodb-atlas-search-index-definition.json | tokenFilters | Array containing zero or more token filters. | {"type": "array", "items": {}} |
mongodb-atlas-search-index-definition.json | Tokenizer | Tokenizer to use to create tokens. | {"type": "object", "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["edgeGram", "keyword", "nGram", "regexCaptureGroup", "regexSplit", "standard", "uaxUrlEmail", "whitespace"]}}, "required": ["type"]} |
mongodb-atlas-search-index-definition.json | type | Human-readable label that identifies this token filter type. | {"type": "string", "enum": ["asciiFolding", "daitchMokotoffSoundex", "edgeGram", "icuFolding", "icuNormalizer", "length", "lowercase", "nGram", "regex", "reverse", "shingle", "snowballStemming", "stopword", "trim"]} |
mongodb-atlas-search-index-definition.json | type | Human-readable label that identifies this character filter type. | {"type": "string", "enum": ["htmlStrip", "icuNormalize", "mapping", "persian"]} |
mongodb-atlas-search-index-definition.json | ignoredTags | List that contains the HTML tags to exclude from filtering. | {"type": "array", "items": {"type": "string"}} |
mongodb-atlas-search-index-definition.json | Mappings | Specifies how to index fields at different paths for this index. | {"type": "object", "oneOf": [{"additionalProperties": false, "properties": {"dynamic": {"const": true}}}, {"additionalProperties": false, "properties": {"dynamic": {"type": "boolean"}, "fields": {"type": "object", "patternProperties": {"^.*$": {"oneOf": [{}, {"type": "array", "items": {}}]}}}}, "required": ["fields"]}]} |
mongodb-atlas-search-index-definition.json | dynamic | Enables or disables dynamic mapping of fields for this index.
If set to true, Atlas Search recursively indexes all fields and embedded documents in the document except:
Fields of certain data types. To learn more, see BSON Data Types.
Any fields explicitly excluded by the mappings.fields parameter.
If set to false, you must specify individual fields to index using mappings.fields.
If omitted, defaults to false. | {"type": "boolean"} |
mongodb-atlas-search-index-definition.json | include | List that contains the field names or dot-separated paths to fields to store.
In addition to the specified fields, Atlas Search stores _id also by default. | {"type": "array", "items": {"type": "string"}} |
mongodb-atlas-search-index-definition.json | exclude | List that contains the field names or dot-separated paths to fields to exclude from being stored.
If specified, Atlas Search stores original documents except the fields listed here. | {"type": "array", "items": {"type": "string"}} |
mongodb-atlas-search-index-definition.json | include | List that contains the field names or dot-separated paths to fields to store.
In addition to the specified fields, Atlas Search stores _id also by default. | {"type": "array", "items": {"type": "string"}} |
mongodb-atlas-search-index-definition.json | exclude | List that contains the field names or dot-separated paths to fields to exclude from being stored.
If specified, Atlas Search stores original documents except the fields listed here. | {"type": "array", "items": {"type": "string"}} |
mongodb-atlas-search-index-definition.json | analyzer | Specifies the analyzer to apply to string fields when indexing.
If you set this only at the top and do not specify an analyzer for the fields in the index definition, Atlas Search applies this analyzer to all the fields.
To use a different analyzer for each field, you must specify a different analyzer for the field.
If omitted, defaults to Standard Analyzer. | {"type": "string"} |
mongodb-atlas-search-index-definition.json | analyzers | Specifies the Custom Analyzers to use in this index. | {"type": "array", "items": {}} |
mongodb-atlas-search-index-definition.json | name | Specifies a name for the index. In each namespace, names of all indexes in the namespace must be unique.
If omitted, defaults to default. | {"type": "string"} |
mongodb-atlas-search-index-definition.json | searchAnalyzer | Specifies the analyzer to apply to query text before searching with it.
If omitted, defaults to Standard Analyzer. | {"type": "string"} |
mongodb-atlas-search-index-definition.json | storedSource | Specifies fields in the documents to store for query-time look-ups using the returnedStoredSource option.
You can store fields of all BSON Data Types on Atlas Search.
Value can be one of the following:
true, to store all fields
false, to not store any fields
Object that specifies the fields to include or exclude from storage
If omitted, defaults to false. | {"oneOf": [{"type": "boolean"}, {}]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.