spec.json

{"components":{"schemas":{"ConfigList":{"properties":{"plugins":{"additionalProperties":{"description":"_key_ is the name of the plugin","properties":{"defs":{"$ref":"#/components/schemas/config_def"}},"type":"object"}},"system":{"properties":{"defs":{"$ref":"#/components/schemas/config_def"}},"type":"object"}},"type":"object"},"ConfigParam":{"discriminator":{"mapping":{"bool":"#/components/schemas/ConfigParamBool","email":"#/components/schemas/ConfigParamEmail","file":"#/components/schemas/ConfigParamFile","form":"#/components/schemas/ConfigParamForm","int":"#/components/schemas/ConfigParamInt","json":"#/components/schemas/ConfigParamJson","license":"#/components/schemas/ConfigParamLicense","location-select":"#/components/schemas/ConfigParamLocationSelect","secret":"#/components/schemas/ConfigParamSecret","select":"#/components/schemas/ConfigParamSelect","string-list":"#/components/schemas/ConfigParamStringList","string-list-sort":"#/components/schemas/ConfigParamStringListSort","table":"#/components/schemas/ConfigParamTable","tagfilter-select":"#/components/schemas/ConfigParamTagfilterSelect","text":"#/components/schemas/ConfigParamText","text-l10n":"#/components/schemas/ConfigParamTextLoca","text-l10n-multiline":"#/components/schemas/ConfigParamTextLocaMultiline","text-multiline":"#/components/schemas/ConfigParamTextMultiline"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ConfigParamBool"},{"$ref":"#/components/schemas/ConfigParamEmail"},{"$ref":"#/components/schemas/ConfigParamFile"},{"$ref":"#/components/schemas/ConfigParamForm"},{"$ref":"#/components/schemas/ConfigParamInt"},{"$ref":"#/components/schemas/ConfigParamJson"},{"$ref":"#/components/schemas/ConfigParamLicense"},{"$ref":"#/components/schemas/ConfigParamLocationSelect"},{"$ref":"#/components/schemas/ConfigParamSecret"},{"$ref":"#/components/schemas/ConfigParamSelect"},{"$ref":"#/components/schemas/ConfigParamStringList"},{"$ref":"#/components/schemas/ConfigParamStringListSort"},{"$ref":"#/components/schemas/ConfigParamTable"},{"$ref":"#/components/schemas/ConfigParamTagfilterSelect"},{"$ref":"#/components/schemas/ConfigParamTextLoca"},{"$ref":"#/components/schemas/ConfigParamTextMultiline"},{"$ref":"#/components/schemas/ConfigParamText"}],"x-recursion":true},"ConfigParamBase":{"properties":{"name":{"description":"name of the parameter as used in the API","type":"string"},"position":{"description":"Position of the parameter in the output.\n","format":"int32","minimum":0,"type":"number"},"type":{"description":"type of the parameter","type":"string"}},"required":["type"],"type":"object"},"ConfigParamBool":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"type":"boolean"}},"type":"object"}],"description":"**bool** is a boolean"},"ConfigParamEmail":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"type":"boolean"}},"type":"object"}],"description":"**email** is an email address consisting of loca part and domain name."},"ConfigParamFile":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"properties":{"_id":{"description":"An eas file id from fylr.","type":"integer"}},"type":"object"}},"type":"object"}],"description":"**file** is an eas file managed by fylr."},"ConfigParamForm":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"additionalProperties":true,"type":"object"},"parameters":{"$ref":"#/components/schemas/ConfigParam"}},"type":"object"}],"description":"**form** is one row of nested parameters."},"ConfigParamInt":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"type":"integer"}},"type":"object"}],"description":"**int** is an integer."},"ConfigParamJson":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"additionalProperties":true,"type":"object"},"plugin_type":{"description":"For some JSON, we support predefined schema.","type":"string"}},"type":"object"}],"description":"The value of this type is and abritrary JSON object."},"ConfigParamLicense":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"$ref":"#/components/schemas/License"}},"type":"object"}],"description":"**license** is an license object."},"ConfigParamLocationSelect":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"description":"Location is a name of a configured location","format":"location","type":"string"}},"type":"object"}],"description":"This presents a location select to the user."},"ConfigParamSecret":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"type":"boolean"}},"type":"object"}],"description":"**secret** is string which will be stored encrypted in the database, if `fylr.encryptionKey` is set."},"ConfigParamSelect":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"type":"string"},"options":{"description":"The list of options available for choice.","items":{"type":"string"},"type":"array"}},"type":"object"}],"description":"**select** is a choice select for one out of a list of options"},"ConfigParamStringList":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"choices":{"description":"The list of options available for choice.","items":{"type":"string"},"type":"array"},"default":{"items":{"type":"string"},"type":"array"}},"type":"object"}],"description":"**string-list** is a list of choices presented to the user."},"ConfigParamStringListSort":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"choices":{"description":"The list of options available for choice.","items":{"type":"string"},"type":"array"},"default":{"items":{"type":"string"},"type":"array"}},"type":"object"}],"description":"**string-list-sort** is a list of sortable choices presented to the user."},"ConfigParamTable":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"additionalProperties":true,"type":"object"},"fields":{"description":"Items of this array are of schema ConfigParam","items":{"$ref":"#/components/schemas/ConfigParam"},"type":"array"}},"type":"object"}],"description":"**table** is rows of parameters"},"ConfigParamTagfilterSelect":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"description":"Tagfilter is a map of sets of ids, as used in the fylr API.","format":"tagfilter","properties":{"all":{"items":{"type":"integer"},"type":"array"},"any":{"items":{"type":"integer"},"type":"array"},"not":{"items":{"type":"integer"},"type":"array"}}}},"type":"object"}],"description":"This presents a tagfilter select to the user."},"ConfigParamText":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"type":"string"}},"type":"object"}],"description":"**text** is a string"},"ConfigParamTextLoca":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"$ref":"#/components/schemas/lang"}},"type":"object"}],"description":"**text-l10n** is a localized string"},"ConfigParamTextLocaMultiline":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"$ref":"#/components/schemas/lang"}},"type":"object"}],"description":"**text-l10n-multinline** is like `text-l10n` but displayed in multiline form."},"ConfigParamTextMultiline":{"allOf":[{"$ref":"#/components/schemas/ConfigParamBase"},{"properties":{"default":{"type":"string"}},"type":"object"}],"description":"**text-multiline** is like `text` but displayed in a mutliline form."},"License":{"properties":{"capabilities":{"type":"object"},"createdAt":{"description":"Timestamp when this license was created.","format":"date-time","type":"string"},"domains":{"description":"Must match fylr.externalURL, allows simple wildcard \"*\".","items":{"type":"string"},"type":"array"},"edition":{"description":"Edition of the license, such as \"workgroup\", \"department\", or \"organization\".","type":"string"},"holder":{"description":"Name of the holder of the license.","type":"string"},"issuer":{"description":"Name of the issuer of the license.","type":"string"},"key":{"description":"UUID of license file, e.g., for blacklisting.","type":"string"},"notes":{"description":"General notes for the customer.","type":"string"},"plugins":{"additionalProperties":{"description":"Set the capabilities for plugins."},"type":"object"},"type":{"description":"Type of license, such as \"subscription\" or \"buy\".","type":"string"},"valid":{"properties":{"from":{"description":"Valid from this date, if empty already valid.","format":"date-time","nullable":true,"type":"string"},"to":{"description":"Valid to this date, if empty license does not expire.","format":"date-time","nullable":true,"type":"string"}},"type":"object"}},"type":"object"},"Tag":{"example":{"_id":1,"displayname":{"de-DE":"Dogs"},"displaytype":"detail","enabled":true,"sticky":true},"properties":{"_id":{"$ref":"#/components/schemas/id"},"_version":{"$ref":"#/components/schemas/version"},"description":{"$ref":"#/components/schemas/lang"},"displayname":{"$ref":"#/components/schemas/lang"},"displaytype":{"description":"* **facet**: Show everywhere, in *facet*, *editor*, *detail* and *search*.\n","enum":["facet","editor","detail","search","hide"],"type":"string"},"enabled":{"description":"Set to **true** if this tag is available?\n","type":"boolean"},"frontend_prefs":{"$ref":"#/components/schemas/frontend_prefs"},"is_default":{"description":"Set to **true** if the tag is set by default when creating new objects.\nThis is a frontend only flag.\n","type":"boolean"},"reference":{"type":"string"},"shortname":{"type":"string"},"sticky":{"description":"If set this tag cannot be removed by Pools which maintain their own tag lists.\n","type":"boolean"}},"type":"object"},"TagGroup":{"properties":{"_basetype":{"enum":["taggroups"],"type":"string"},"_tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"taggroup":{"properties":{"_id":{"format":"int64","minimum":1,"nullable":true,"type":"number"},"reference":{"type":"string"},"shortname":{"type":"string"},"type":{"description":"A tag group of type **checkbox** can set multiple tags of that group. A tag group\nof type **choice** can only set one tag of that group.\n","enum":["checkbox","choice"],"type":"string"}},"type":"object"}},"type":"object"},"config_def":{"items":{"description":"Each item describes a config setting.","properties":{"group":{"description":"The **group** sets the tab this config variable is in.","type":"string"},"name":{"description":"The unique name of this config","type":"string"},"parameters":{"$ref":"#/components/schemas/ConfigParam"},"require_system_right":{"description":"System right which this config requires, e.g. \"system.root\" if it requires root rights.","type":"string"},"unauthenticated_visible":{"description":"If true, this config is visible to unauthenticated sessions (access token with no user).","type":"boolean"}},"type":"object"},"type":"array"},"config_list":{"properties":{"plugins":{"additionalProperties":{"description":"_key_ is the name of the plugin","properties":{"defs":{"$ref":"#/components/schemas/config_def"}},"type":"object"}},"system":{"properties":{"defs":{"$ref":"#/components/schemas/config_def"}},"type":"object"}},"type":"object"},"file":{"properties":{"_duplicates":{"description":"If set, this attribute can hold an array of duplicates.\n","items":{"properties":{"_id":{"description":"The `file._id` of the detected duplicate.","format":"int64","type":"number"},"certainty":{"description":"The certainty of the duplicate detection in percent. A value of 1.0 means 100%. Currently **fylr** can only detect exact same files (as per file hash).\n","format":"float64","type":"number"},"linked_system_objects":{"items":{"properties":{"_column_id":{"description":"The column API id of the column holding the duplicate file.\n","format":"int64","type":"number"},"_system_object_id":{"description":"The `_system_object_id` of the object using the duplicate file.\n","format":"int64","type":"number"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"_id":{"description":"The `_id` is **created** _when_ a file is uploaded into the fylr server.\n","format":"int64","minimum":1,"type":"number"},"_linked_objects":{"description":"When a file is uploaded and linked to a collection via [`/api/eas`](https://docs.fylr.io/for-developers/api/endpoints/api-eas), the attribute contains a list of objects created based on the upload settings of that collection.\n","items":{"properties":{"_system_object_id":{"description":"The `_system_object_id` of the object created.\n","format":"int64","type":"number"},"_version":{"description":"The `_version` of the object created or updated. An upload may update an existing object if a version or series detection added a file to an existing nested or an existing file array.\n","format":"int64","type":"number"}},"type":"object"},"type":"array"},"_mapped_metadata":{"description":"A rendered version of the object data retrived and mapped from this file's metadata. It can be used to create objects based on a pre-configured metadata mapping.\n","type":"object"},"best_date":{"description":"Best date is a compiled UTC timestamp from the technical metadata. **fylr** uses the first set date from `technical_metadata.date_time_original`, `technical_metadata.create_date`, `date_uploaded`.\n","format":"timestamp","type":"string"},"children":{"description":"For originals which use a pageable format, like `PDF`, this attribute contains the pages available underneath the original. The format is string and the value is using the file's `_id` and the page number (starting at `0`) separated by `/`.","items":{"type":"string"},"type":"array"},"class":{"description":"The compiled class of the file. The classes are set by the recipe. Standard recipes of fylr include `image`, `audio`, `office`, `video`. The fylr frontend uses the class to pick the general player to view the file. A class `unknown` is assigned if no matching recipe was found but the upload accepts _unknown types_.\n","type":"string"},"class_extension":{"description":"A compiled concatenation of `class`, `version`, joined by `.`. This is used for aggregations of files\n","type":"string"},"class_version_status":{"description":"A compiled concatenation of `class`, `version` and `status`, joined by `.`. This is used for aggregations of file status.\n","type":"string"},"compiled":{"description":"A compiled version of the metadata for this file. For images this looks like this: `\tJPG, 1920 x 1285 px, 569.5 kB`.\n","type":"string"},"compiled_props":{"description":"A fielded version of `compiled`. Frontends can use this to beatify the compiled output of the metadata.\n","properties":{"dimensions":{"description":"The rendered dimensions for this file. This may include a unit. For page sizes European paper sizes like A4 will be recognised.\n","type":"string"},"duration":{"description":"Runtime of the audio or video file.\n","type":"string"},"extension":{"description":"The upper cased version of the `extension`.\n","type":"string"},"pages":{"description":"The number of pages followed by a ` p.`. Frontends may localize this manually.\n","type":"string"}},"type":"object"},"date_uploaded":{"description":"The UTC timestamp when this file was uploaded.\n","format":"timestamp","type":"string"},"eas_parent_id":{"description":"The `eas_parent_id` is the id of the file this file is derived from. When using **/api/produce**, the newly produced files will get the parent id set to the file they are produced from.\n","format":"int64","nullable":true,"type":"number"},"extension":{"description":"The compiled extension of the file. This is matched by parsing available recipes at the time of the metadata generation. Extensions are matched by longer length first. So for a file `flower.webdvd.zip` the extension matched would be `.webdvd.zip` and not `.zip` if there is an available recipe.\n","type":"string"},"filesize":{"description":"The file size in bytes.\n","format":"int64","type":"number"},"frontend_prefs":{"additionalProperties":true,"description":"Set only in relation to an object. This map can contain custom attributes and values.\n","type":"object"},"hash":{"description":"The `hash` is a non unique identifier of the file. For remote files, it is the [**md5sum**](https://en.wikipedia.org/wiki/Md5sum) of the URL, for local files it is the [**SHA-256**](https://en.wikipedia.org/wiki/SHA-2) of the binary file data. It is calculated together with the metadata for the file and a copy of `technical_metadata.sha256_hash`. The `hash` is used for duplicate detection.\n","type":"string"},"is_original":{"description":"Set to true if the file is an original. It is false if the file is a generated or uploaded rendition. Produced files are registered as originals underneath the original they are produced from.\n","type":"boolean"},"last_status_at":{"description":"The UTC timestamp when the last status change was last written to the database.\n","format":"timestamp","type":"string"},"lookup:_id":{"properties":{"reference":{"description":"The `reference` of the file to look up.\n","type":"string"}},"type":"object"},"metadata":{"properties":{"groupnames":{"description":"Sorted list of metadata group names found in `groups`.\n","items":{"type":"string"},"type":"array"},"groups":{"additionalProperties":{"items":{"properties":{"group":{"description":"The group name of the attribute\n","type":"string"},"name":{"description":"The name of the attribute.\n","type":"string"},"print":{"description":"A printable version of `value`\n","type":"string"},"value":{"description":"The value can be any type\n"}},"type":"object"},"type":"array"},"type":"object"}},"type":"object"},"name":{"description":"Custom name of the file. This is set in the relation to the object. When retrieving the file via [`/api/eas`](https://docs.fylr.io/for-developers/api/endpoints/api-eas).\n","type":"string"},"original_filename":{"description":"The filename as set by `original_filepath` minus the path.\n","type":"string"},"original_filename_basename":{"description":"The filename as set by `original_filepath` minus the path and the detected `extension`.\n","type":"string"},"original_filepath":{"description":"Filename of the file as set during the upload. On Windows, this can contain drive letters and backslashes.\n","type":"string"},"pages_allowed":{"description":"Indicates that the file has pages.\n","type":"boolean"},"preferred":{"description":"This may be set if the file is in the context of an object. If set, preferred indicates that this version is the preferred one in a list of other versions.\n","type":"boolean"},"reference":{"description":"If set, this reference string is a unique string identifying the file. If the reference contains a `sha244:\u003chash\u003e` or `sha256:\u003chash\u003e`, the provided hash can be checked against the file's checksum using an action triggerable in **/inspect/files**. Other parts of the reference can be added but must be separated by `:`.\n","nullable":true,"type":"string"},"status":{"description":"The status of the file. Known states are: `pending`, `processing`, `sync`, `done`, `failed`. Files and renditions can be accessed in status `sync` and `done`. Only files in state `done` can be exported.\n","type":"string"},"technical_metadata":{"description":"An object to describe technical aspects of the file. See [Technical Metadata](https://docs.fylr.io/for-developers/system-data-types/file#technical_metadata) for details.\n","type":"object"},"upload_user":{"description":"The user who uploaded this file into the system. If the upload happens via Hotfolder, the uploader is the owner of the upload collection.\n","properties":{"_basetype":{"default":"user","description":"**\"user\"**. More info can be found [here](./user.md) [here2](../system-data-types/user.md) [here3](../../for-developers/system-data-types/user.md) [here4](https://docs.fylr.io/for-developers/system-data-types/user)\n","type":"string"},"user":{"description":"This will show a short representation of [user](https://docs.fylr.io/for-developers/system-data-types/user).\n","type":"object"}},"type":"object"},"versions":{"additionalProperties":{"description":"The file version specification can be found [here](https://docs.fylr.io/for-developers/system-data-types/file#file_version).\n","type":"object"},"description":"`versions` contains a map with renditions for the file. Depending on the users permissions, not all versions might be accessible.\n","type":"object"}},"type":"object"},"file_version":{"properties":{"_download_allowed":{"type":"string"},"_id":{"type":"string"},"aspect_ratio":{"type":"string"},"blurhash":{"type":"string"},"class":{"type":"string"},"class_extension":{"type":"string"},"date_created":{"type":"string"},"deep_link_url":{"type":"string"},"delete_url":{"type":"string"},"dpi":{"type":"string"},"extension":{"type":"string"},"filesize":{"type":"string"},"hash":{"type":"string"},"height":{"type":"string"},"iiif_url":{"type":"string"},"last_status_at":{"type":"string"},"orientation":{"type":"string"},"path":{"type":"string"},"percent_done":{"type":"string"},"status":{"type":"string"},"technical_metadata":{"type":"string"},"url":{"type":"string"},"watermark":{"type":"string"},"width":{"type":"string"},"zoom_url":{"type":"string"}},"type":"object"},"frontend_prefs":{"additionalProperties":true,"description":"Frontend preferences can be any JSON Map with data used by applications. The\nconventions here is that each application can use its on key on the top level\nof this Map. Only this key may be modified by the application, foreign keys\nmust be kept unchanged.\n","example":{"webfrontend":{"color":"red","icon\"":"fa-ban"}},"type":"object"},"id":{"description":"The **_id** is a used to uniquely identify an object. It is automatically\nassigned by the server for new objects.\n\nIt is possible to manually set the **_id**, the internal sequence will be\nadopted accordingly.\n","format":"int64","minimum":1,"nullable":true,"type":"number"},"lang":{"description":"Texts used to for language aware contexts.\n","example":{"de-DE":"Deutscher text","en-US":"English text"},"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"license":{"properties":{"capabilities":{"type":"object"},"createdAt":{"description":"Timestamp when this license was created.","format":"date-time","type":"string"},"domains":{"description":"Must match fylr.externalURL, allows simple wildcard \"*\".","items":{"type":"string"},"type":"array"},"edition":{"description":"Edition of the license, such as \"workgroup\", \"department\", or \"organization\".","type":"string"},"holder":{"description":"Name of the holder of the license.","type":"string"},"issuer":{"description":"Name of the issuer of the license.","type":"string"},"key":{"description":"UUID of license file, e.g., for blacklisting.","type":"string"},"notes":{"description":"General notes for the customer.","type":"string"},"plugins":{"additionalProperties":{"description":"Set the capabilities for plugins."},"type":"object"},"type":{"description":"Type of license, such as \"subscription\" or \"buy\".","type":"string"},"valid":{"properties":{"from":{"description":"Valid from this date, if empty already valid.","format":"date-time","nullable":true,"type":"string"},"to":{"description":"Valid to this date, if empty license does not expire.","format":"date-time","nullable":true,"type":"string"}},"type":"object"}},"type":"object"},"tag":{"example":{"_id":1,"displayname":{"de-DE":"Dogs"},"displaytype":"detail","enabled":true,"sticky":true},"properties":{"_id":{"$ref":"#/components/schemas/id"},"_version":{"$ref":"#/components/schemas/version"},"description":{"$ref":"#/components/schemas/lang"},"displayname":{"$ref":"#/components/schemas/lang"},"displaytype":{"description":"* **facet**: Show everywhere, in *facet*, *editor*, *detail* and *search*.\n","enum":["facet","editor","detail","search","hide"],"type":"string"},"enabled":{"description":"Set to **true** if this tag is available?\n","type":"boolean"},"frontend_prefs":{"$ref":"#/components/schemas/frontend_prefs"},"is_default":{"description":"Set to **true** if the tag is set by default when creating new objects.\nThis is a frontend only flag.\n","type":"boolean"},"reference":{"type":"string"},"shortname":{"type":"string"},"sticky":{"description":"If set this tag cannot be removed by Pools which maintain their own tag lists.\n","type":"boolean"}},"type":"object"},"taggroup":{"properties":{"_basetype":{"enum":["taggroups"],"type":"string"},"_tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"taggroup":{"properties":{"_id":{"format":"int64","minimum":1,"nullable":true,"type":"number"},"reference":{"type":"string"},"shortname":{"type":"string"},"type":{"description":"A tag group of type **checkbox** can set multiple tags of that group. A tag group\nof type **choice** can only set one tag of that group.\n","enum":["checkbox","choice"],"type":"string"}},"type":"object"}},"type":"object"},"technical_metadata":{"properties":{"aspect_ratio":{"format":"float64","type":"number"},"audio_codec":{"items":{"type":"string"},"type":"array"},"blurhash":{"type":"string"},"camera_scanner":{"type":"string"},"colordepth":{"format":"int","type":"number"},"colorprofile":{"type":"string"},"colorspace":{"type":"string"},"create_date":{"type":"string"},"date_time_original":{"type":"string"},"dimensions":{"properties":{"height":{"format":"float64","type":"number"},"unit":{"type":"string"},"width":{"format":"float64","type":"number"}},"type":"object"},"dpi":{"format":"int","type":"number"},"duration":{"format":"int","type":"number"},"file_type_extension":{"type":"string"},"filesize":{"format":"int64","type":"number"},"format":{"description":"The format of the file: `landscape`, `portrait` or `square`.\n","type":"string"},"gps_location":{"properties":{"altitude":{"format":"float64","type":"number"},"latitude":{"format":"float64","type":"number"},"longitude":{"format":"float64","type":"number"}},"type":"object"},"has_clipping_path":{"type":"boolean"},"height":{"format":"int","type":"number"},"max_dimension":{"format":"int","type":"number"},"mime_type":{"type":"string"},"num_glyphs":{"format":"int","type":"number"},"orientation":{"type":"string"},"pages":{"format":"int","type":"number"},"sha256_hash":{"type":"string"},"video_codec":{"items":{"type":"string"},"type":"array"},"width":{"format":"int","type":"number"}},"type":"object"},"user":{"properties":{"_generated_displayname":{"description":"The generated displayname of the user. This uses `login` and `email`.\n","type":"string"},"_id":{"description":"The id of the user. It is automatically assigned.\n","format":"int64","type":"number"}},"type":"object"},"version":{"description":"The **_version** needs to be set to **1** for new objects and set to an\nincremented number on each object update. This is used to ensure that two\nclients do not overwrite data of the same object.\n","format":"int64","minimum":1,"type":"number"}}},"info":{"description":"This API documentation is work in progress and not yet complete.\n","title":"FYLR API","version":"1.0.0"},"openapi":"3.0.2","paths":{"/config":{"description":"Administrators can define base configuration using this API. fylr has a basic\nset of configuration items which are in the core system, such as the name of\nthe instance, administrator's main address, language definitions and so on.\n\nFrontends are required to implement a generic form editor for base\nconfiguration items. The list of items can be retrieved using the\n[config/list](list/) API.\n\nThis list is not stable and can be changed without API change in any new\nversion of fylr. Plugins can extend the list of configuration items. So,\ndepending on the list of loaded plugins in fylr, the list has a various number\nof items.\n","get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"plugin":{"properties":{"ai-metadata":{"properties":{"config":{"properties":{"apikey":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"debug":{"type":"boolean"},"fields":{"items":{"properties":{"name":{"type":"string"},"question":{"type":"string"},"type":{"enum":["list","localized","localized list","text"],"type":"string"}},"type":"object"},"type":"array"},"upload_file_size":{"enum":["big","medium","small"],"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-dante":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-gazetteer":{"properties":{"config":{"properties":{"days":{"type":"integer"},"enabled":{"type":"boolean"},"field_from":{"type":"string"},"field_to":{"type":"string"},"objecttype":{"type":"string"},"on_update":{"type":"boolean"},"show_alternative_names":{"type":"boolean"},"show_lat_lng":{"type":"boolean"}},"type":"object"}},"type":"object"},"custom-data-type-geonames":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"},"geonames_username":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-gnd":{"properties":{"config":{"properties":{"days":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-gvk":{"properties":{"config":{"properties":{"days":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-html-editor":{"properties":{"config":{"properties":{"custom_css_url":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-iconclass":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-iucn":{"properties":{"config":{"properties":{"api_token":{"type":"string"},"api_url":{"type":"string"},"days":{"type":"integer"},"easydb_login":{"type":"string"},"easydb_password":{"type":"string"},"iucn_fields":{"items":{"properties":{"iucn_field_name":{"type":"string"}},"type":"object"},"type":"array"},"tag_red":{"type":"integer"},"tag_unclear":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-link":{"properties":{"config":{"properties":{"templates":{"items":{"properties":{"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"name":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"placeholders":{"items":{"properties":{"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"key":{"type":"string"}},"type":"object"},"type":"array"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-auto-keyworder-plugin":{"properties":{"config":{"properties":{"configs":{"items":{"properties":{"api_key":{"type":"string"},"asset_field":{"type":"string"},"asset_version":{"type":"string"},"config_enabled":{"type":"boolean"},"keyword_categories_field":{"type":"string"},"keyword_color_field":{"type":"string"},"keyword_gender_field":{"type":"string"},"keyword_material_field":{"type":"string"},"keyword_quantity_field":{"type":"string"},"language":{"enum":["ar","cs-CZ","de-DE","en-US","es-ES","fa","fr-FR","it-IT","ja-Jpan","ka-GE","ko-Kore","nl-NL","pl-PL","ru-RU","zh-Hans"],"type":"string"},"min_age_days":{"type":"integer"},"name":{"type":"string"},"objecttype":{"type":"string"},"service":{"enum":["Cloudsight.ai"],"type":"string"},"subject_field":{"type":"string"},"tagfilter":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"},"timestamp_field":{"type":"string"}},"type":"object"},"type":"array"},"easydb_password":{"type":"string"},"easydb_session_token":{"type":"string"},"easydb_user":{"type":"string"},"enabled":{"type":"boolean"},"request_status_delay":{"type":"integer"},"request_status_repititions":{"type":"integer"},"start_now":{"type":"boolean"}},"type":"object"}},"type":"object"},"easydb-connector-plugin":{"properties":{"config":{"properties":{"easydb_id":{"type":"string"},"easydbs":{"items":{"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"enable":{"type":"boolean"},"https_insecure":{"type":"boolean"},"login":{"type":"string"},"name":{"type":"string"},"password":{"type":"string"},"timeout_sec":{"type":"integer"},"url":{"type":"string"}},"type":"object"},"type":"array"},"enable_all":{"type":"boolean"},"objecttype":{"type":"string"},"table_id":{"type":"string"},"table_name":{"type":"string"},"table_ref_col":{"type":"string"},"url":{"type":"string"}},"type":"object"}},"type":"object"},"easydb-detail-map-plugin":{"properties":{"config":{"properties":{"enabled":{"type":"boolean"},"mapboxToken":{"type":"string"},"tiles":{"enum":["Mapbox","OpenStreetMaps"],"type":"string"}},"type":"object"}},"type":"object"},"easydb-drupal-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"}},"type":"object"}},"type":"object"},"easydb-easydb4migration-plugin":{"properties":{"config":{"properties":{"fylr_inst":{"type":"string"},"fylr_uid":{"type":"string"},"fylr_url":{"type":"string"}},"type":"object"}},"type":"object"},"easydb-editor-tagfilter-defaults-plugin":{"properties":{"config":{"properties":{"filters":{"items":{"properties":{"default":{"type":"string"},"mask_id":{"type":"integer"},"operation":{"items":{"enum":["insert","update"],"type":"string"},"type":"array"},"pool_id":{"type":"string"},"tagfilter":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-falconio-plugin":{"properties":{"config":{"properties":{"fio_instances":{"items":{"properties":{"active":{"type":"boolean"},"auth":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-remote-plugin":{"properties":{"config":{"properties":{"instances":{"items":{"properties":{"css_url":{"type":"string"},"js_url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-typo3-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"profile_mapping":{"type":"integer"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"}},"type":"object"}},"type":"object"},"easydb-wordpress-plugin":{"properties":{"config":{"properties":{"wp_instances":{"items":{"properties":{"auth":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"example-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"bool":{"type":"boolean"},"date":{"type":"string"},"easydb_group":{"type":"integer"},"email":{"format":"email","type":"string"},"example_base_config":{"type":"string"},"int":{"type":"integer"},"profile_mapping":{"type":"integer"},"select":{"enum":["apple","banana","kiwi"],"type":"string"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"},"string_list":{"items":{"enum":["one","three","two"],"type":"string"},"type":"array"},"string_list_sort":{"items":{"enum":["one","three","two"],"type":"string"},"type":"array"},"tag_select":{"items":{"type":"integer"},"type":"object","x-type":"tag-select"},"tagfilter_select":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"},"text":{"type":"string"},"text_l10n":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"text_l10n_multi":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"text_multi":{"type":"string"},"webhook_secret":{"type":"string"}},"type":"object"}},"type":"object"},"fylr_example":{"properties":{"config":{"properties":{"data":{"type":"object","x-type":"json"},"on_off":{"type":"boolean"},"value":{"type":"string"}},"type":"object"}},"type":"object"},"pdf-creator":{"properties":{"config":{"properties":{"custom_css_url":{"type":"string"},"fylr_url":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"system":{"properties":{"config":{"properties":{"appearance":{"properties":{"background_color":{"type":"string"},"brand_color":{"type":"string"},"favicon":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"login_background":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"logo":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"logo_external_url":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"tag_colors":{"items":{"properties":{"tag_color":{"type":"string"}},"type":"object"},"type":"array"},"tag_icons":{"items":{"properties":{"fa-icon":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"colorprofiles":{"properties":{"profiles":{"items":{"properties":{"profile":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"profilename":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"custom_data_type_updater":{"properties":{"active":{"type":"boolean"}},"type":"object"},"deep_link_access":{"properties":{"allow_access_by_column":{"type":"boolean"},"allow_access_by_id":{"type":"boolean"},"enabled":{"type":"boolean"},"iiif_default_links":{"type":"boolean"},"iiif_links":{"items":{"properties":{"html_code":{"type":"string"},"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"iiif_required_statement":{"properties":{"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"value":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"include_parents":{"type":"boolean"},"merge_linked_objects":{"enum":["all","none","not_in_main_search","not_in_main_search_unless_reverse"],"type":"string"},"merge_max_depth":{"type":"integer"}},"type":"object"},"detail_deep_link":{"properties":{"use_system_object_id":{"type":"boolean"}},"type":"object"},"email":{"properties":{"admin_emails":{"items":{"properties":{"email":{"format":"email","type":"string"}},"type":"object"},"type":"array"},"from":{"format":"email","type":"string"},"signature":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"email_server":{"properties":{"cram_md5_auth":{"properties":{"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"helo_domain":{"type":"string"},"insecure_skip_verify":{"type":"boolean"},"login_auth":{"properties":{"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"plain_auth":{"properties":{"identity":{"type":"string"},"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"server_addr":{"type":"string"},"type":{"enum":["off","starttls","tls"],"type":"string"}},"type":"object"},"export":{"properties":{"xslts":{"items":{"properties":{"description":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"namespace":{"type":"string"},"oai_pmh_prefix":{"type":"string"},"schema":{"type":"string"},"use_for_api_objects":{"type":"boolean"},"use_for_oai_pmh":{"type":"boolean"},"xslt":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"}},"type":"object"},"type":"array"}},"type":"object"},"export_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"file_url_expire":{"properties":{"deep_link_days":{"type":"integer"},"default_days":{"type":"integer"},"max_days":{"type":"integer"},"oai_pmh_days":{"type":"integer"}},"type":"object"},"janitor":{"properties":{"active":{"type":"boolean"},"event_remote_addr_expire_days":{"type":"integer"},"events":{"properties":{"expire_days_ADMIN":{"type":"integer"},"expire_days_DOWNLOAD":{"type":"integer"},"expire_days_EXPORT":{"type":"integer"},"expire_days_FRONTEND":{"type":"integer"},"expire_days_INDEX":{"type":"integer"},"expire_days_LOGIN_LOGOUT":{"type":"integer"},"expire_days_PLUGIN":{"type":"integer"},"expire_days_SYSTEM":{"type":"integer"},"expire_days_UPLOAD":{"type":"integer"}},"type":"object"},"file_expire_days":{"type":"integer"},"users":{"properties":{"archive_nonactive_after_days":{"type":"integer"},"archive_types":{"items":{"enum":["anonymous","easydb","easydb_self_register","ldap","sso"],"type":"string"},"type":"array"},"delete_archived_after_days":{"type":"integer"}},"type":"object"}},"type":"object"},"languages":{"properties":{"database":{"items":{"properties":{"date_format":{"enum":["ca","cldr","da","de","us"],"type":"string"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"number_format":{"enum":["ca","cldr","de","fi","it","us"],"type":"string"},"time_format":{"enum":["cldr","da","de","us"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"frontend":{"items":{"enum":["da-DK","de-DE","en-US","fi-FI","fr-FR","it-IT","ru-RU","sv-SE","uz-UZ"],"type":"string"},"type":"array"}},"type":"object"},"ldap":{"properties":{"bindpassword":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"bindusername":{"type":"string"},"connections":{"items":{"properties":{"tls_ca_cert":{"type":"string"},"tls_insecure":{"type":"boolean"},"tls_start":{"type":"boolean"},"url":{"type":"string"}},"type":"object"},"type":"array"},"debug":{"type":"boolean"},"groupbasedn":{"type":"string"},"groupfilter":{"type":"string"},"groupmapping":{"items":{"properties":{"group":{"type":"string"}},"type":"object"},"type":"array"},"userbasedn":{"type":"string"},"userfilter":{"type":"string"},"usermapping":{"items":{"properties":{"key":{"enum":["company","department","displayname","email","first_name","last_name","login","phone","reference"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"userupdatecolumn":{"enum":["email","login","reference"],"type":"string"}},"type":"object"},"license":{"properties":{"license":{"$ref":"#/components/schemas/License"}},"type":"object"},"loca":{"properties":{"google_csv":{"items":{"properties":{"gid":{"type":"integer"},"key":{"type":"string"}},"type":"object"},"type":"array"},"google_overload_csv":{"type":"boolean"}},"type":"object"},"location_defaults":{"properties":{"backups":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"},"originals":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"},"versions":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"}},"type":"object"},"logging":{"properties":{"level":{"enum":["","debug","error","info","trace","warn"],"type":"string"},"timings":{"type":"boolean"}},"type":"object"},"login":{"properties":{"guest":{"type":"boolean"},"info":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"placeholder":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"name":{"properties":{"description":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"internal_name":{"type":"string"},"title":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"notification_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"oai_pmh":{"properties":{"admin_email":{"items":{"properties":{"email":{"format":"email","type":"string"}},"type":"object"},"type":"array"},"enabled":{"type":"boolean"},"include_parents":{"type":"boolean"},"merge_linked_objects":{"enum":["all","none","not_in_main_search","not_in_main_search_unless_reverse"],"type":"string"},"merge_max_depth":{"type":"integer"},"namespace_identifier":{"type":"string"},"records_limit":{"type":"integer"},"repository_name":{"type":"string"},"tagfilter_sets":{"items":{"properties":{"set_name":{"type":"string"},"tagfilter":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"oauth2":{"properties":{"clients":{"items":{"properties":{"name":{"type":"string"},"redirect_uris":{"items":{"properties":{"url":{"type":"string"}},"type":"object"},"type":"array"},"secret":{"type":"string"}},"type":"object"},"type":"array"},"expirations":{"properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"}},"type":"object"}},"type":"object"},"objectstore":{"properties":{"instance":{"type":"string"},"server":{"type":"string"},"uid":{"type":"string"}},"type":"object"},"openapi_spec_endpoint":{"properties":{"active":{"type":"boolean"}},"type":"object"},"openid":{"properties":{"userinfo":{"items":{"enum":["address_supplement","company","country","department","displayname","email","first_name","house_number","last_name","phone","postal_code","state","street","town"],"type":"string"},"type":"array"}},"type":"object"},"password":{"properties":{"check":{"items":{"properties":{"regexp":{"type":"string"}},"type":"object"},"type":"array"},"hint":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"showforgot":{"type":"boolean"}},"type":"object"},"plugin_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"produce_config":{"properties":{"value":{"properties":{"classes":{"description":"The produce config defines the renditions (preview versions) produce by the file workers. It includes the parameters for the recipes and defines file extension based routing.","properties":{"audio":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"audioconverter:convert\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format [select]","enum":["aac"],"type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"audioconverter:convert\"","type":"string"}},"type":"object"},{"description":"Recipe \"audioconverter:preview\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"audioconverter:preview\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"image":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"fylr_example:example_image:grayPy\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"fylr_example:example_image:grayPy\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:browserthumbs\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"background":{"description":"For background color, defaults to black (if no Alpha channel is available). [select]","enum":["","black","white"],"type":"string"},"clip":{"description":"When converting TIFF to PNG use embedded clipping path to remove background. [bool]","type":"boolean"},"colorprofile":{"description":" [select]","enum":["","ACESCG Linear","AdobeRGB1998","DCI(P3) RGB","Display P3","Generic CMYK Profile","Generic Gray Gamma 2.2 Profile","Generic Gray Profile","Generic Lab Profile","Generic RGB Profile","Generic XYZ Profile","ISOcoated_v2_eci","ITU-2020","ITU-709","ROMM RGB","eciRGB_v2","sRGB Profile","sRGB_IEC61966-2-1_black_scaled"],"type":"string"},"colorspace":{"description":" [select]","enum":["","cmyk","srgb"],"type":"string"},"enlarge":{"description":"Enlarge output if the original is smaller than the requested size [bool]","type":"boolean"},"format":{"description":"Output format of the thumbnail. [select]","enum":["jpg","png"],"type":"string"},"jpegquality":{"description":"JPEG quality: 1 (worst) to 100 (best). Use 0 to not explicitely set quality. [int]","type":"integer"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"Set the output size. Use 0 to keep the original size. [int]","type":"integer"},"size_minimum":{"description":"Only produce version if source size is greater or equal size_minimum. [int]","type":"integer"},"strip":{"description":"Strip metadata from thumbnail. [bool]","type":"boolean"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:browserthumbs\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:preview_pool_watermark\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"},"size_minimum":{"description":"only produce version if source size is greater or equal size_minimum [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:preview_pool_watermark\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:vectortosvg\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","eps","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","eps","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:vectortosvg\"","type":"string"}},"type":"object"},{"description":"Recipe \"fylr_example:example_image:grayIM\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"fylr_example:example_image:grayIM\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"office":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["csv","doc","docx","odp","ods","odt","otf","pdf","ppt","pptx","rtf","ttf","txt","xls","xlsx"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"officeconverter:font\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["otf","ttf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["otf","ttf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"size":{"description":"set the output size. This will produce a squared preview [int]","type":"integer"},"text":{"description":"text to render on the preview [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:font\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:pdf\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:pdf\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:preview\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:preview\"","type":"string"}},"type":"object"},{"description":"Recipe \"pdfconverter:pdfpages\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["pdf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["pdf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"pdfconverter:pdfpages\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:browserthumbs\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["pdf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["pdf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:browserthumbs\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"video":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"videoconverter:resize\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"ffmpeg_params":{"description":"additional ffmpeg options for the video production [string]","type":"string"},"height":{"description":"set the output height [int]","type":"integer"},"height_minimum":{"description":"only produce version if source height is greater or equal height_minimum [int]","type":"integer"},"timeout":{"description":"maximum duration to encode the video, e.g. \"1m\" or \"1h\" [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"videoconverter:resize\"","type":"string"}},"type":"object"},{"description":"Recipe \"videoconverter:thumbnail\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"set the format of the target. [select]","enum":["jpg","png"],"type":"string"},"size":{"description":"set the target size (eg 128) [string]","type":"string"},"timeout":{"description":"maximum duration to produce the thumbnail, e.g. \"1m\" or \"1h\" [string]","type":"string"},"video-thumb-select":{"description":"\"hh:mm:ss.sss\", \"ss.sss\", \"auto\" or \"no-ffmpegthumbnailer\".\n [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"videoconverter:thumbnail\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"}},"type":"object"},"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the original or version matches.","items":{"enum":["3gp","aac","ai","aiff","arw","asf","avi","bmp","cr2","crw","csv","dng","doc","docx","dts","eps","flac","flv","gif","heic","hevc","ico","jfif","jp2","jpeg","jpg","m2v","m4a","m4v","mjpeg","mkv","mov","mp2","mp3","mp4","mpeg","mpg","mts","mxf","nef","odp","ods","odt","oga","ogg","ogv","opus","otf","pdf","png","ppm","ppt","pptx","psd","ra","raf","rm","rtf","rw2","svg","swf","tif","tiff","ts","ttf","txt","vob","wav","webm","webp","wma","wmf","wmv","wtv","xls","xlsx"],"type":"string"},"type":"array"},"includeversions":{"description":"If set, the custom metadata is produces not only for originals but also for all versions.","type":"boolean"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"uploadallowunknown":{"description":"If set, the upload of file types which are not enabled in any \"uploadenabledextensions\", is allowed.","type":"boolean"},"uploadmaxfilesize":{"description":"The upload maximum file size (can be overwritten by each class), given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"}},"type":"object","x-type":"json"}},"type":"object"},"publish":{"properties":{"collectors":{"items":{"properties":{"display_format":{"enum":["name","name_type","name_type_doi","type"],"type":"string"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"internalname":{"type":"string"},"logo":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"prefix":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"purge":{"properties":{"allow_purge":{"type":"boolean"},"purge_storage":{"type":"boolean"}},"type":"object"},"register":{"properties":{"enable":{"type":"boolean"},"form":{"properties":{"address":{"enum":["hide","require","show"],"type":"string"},"company":{"enum":["hide","require","show"],"type":"string"},"department":{"enum":["hide","require","show"],"type":"string"},"displayname":{"enum":["hide","require","show"],"type":"string"},"first_name":{"enum":["hide","require","show"],"type":"string"},"last_name":{"enum":["hide","require","show"],"type":"string"},"phone":{"enum":["hide","require","show"],"type":"string"}},"type":"object"},"groups":{"items":{"properties":{"group":{"type":"integer"}},"type":"object"},"type":"array"},"info":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"saml":{"properties":{"cert":{"type":"string"},"debug":{"type":"boolean"},"groupmapping":{"items":{"properties":{"group":{"type":"string"}},"type":"object"},"type":"array"},"key":{"type":"string"},"ldap":{"properties":{"bindpassword":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"bindusername":{"type":"string"},"connections":{"items":{"properties":{"tls_ca_cert":{"type":"string"},"tls_insecure":{"type":"boolean"},"tls_start":{"type":"boolean"},"url":{"type":"string"}},"type":"object"},"type":"array"},"groupbasedn":{"type":"string"},"groupfilter":{"type":"string"}},"type":"object"},"loginlink":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"loginpreferred":{"type":"boolean"},"signrequest":{"enum":["","sha1","sha256","sha512"],"type":"string"},"url":{"type":"string"},"usermapping":{"items":{"properties":{"key":{"enum":["company","department","displayname","email","first_name","last_name","login","phone","reference"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"userupdatecolumn":{"enum":["email","login","reference"],"type":"string"}},"type":"object"},"transition_webhook":{"properties":{"webhooks":{"items":{"properties":{"include_access_token":{"type":"boolean"},"name":{"type":"string"},"secret":{"type":"string"},"send_authorization_header":{"type":"boolean"},"timeout":{"type":"integer"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"user":{"properties":{"copy_to_event":{"items":{"enum":["address_supplement","company","country","department","first_name","house_number","last_name","login","phone","postal_code","reference","state","street","town"],"type":"string"},"type":"array"},"default_delete_policy":{"enum":["archive","ask","delete"],"type":"string"},"user_in_event_group":{"items":{"enum":["ADMIN","DOWNLOAD","EXPORT","FRONTEND","LOGIN_LOGOUT","PLUGIN","SYSTEM","UPLOAD"],"type":"string"},"type":"array"}},"type":"object"},"webdav":{"properties":{"hotfolder":{"type":"boolean"},"hotfolder_wait_sec":{"type":"integer"},"read_write_access":{"type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"The response contains the base configuration values.\n"}},"summary":"Get all base configuration","tags":["config"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"plugin":{"properties":{"ai-metadata":{"properties":{"config":{"properties":{"apikey":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"debug":{"type":"boolean"},"fields":{"items":{"properties":{"name":{"type":"string"},"question":{"type":"string"},"type":{"enum":["list","localized","localized list","text"],"type":"string"}},"type":"object"},"type":"array"},"upload_file_size":{"enum":["big","medium","small"],"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-dante":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-gazetteer":{"properties":{"config":{"properties":{"days":{"type":"integer"},"enabled":{"type":"boolean"},"field_from":{"type":"string"},"field_to":{"type":"string"},"objecttype":{"type":"string"},"on_update":{"type":"boolean"},"show_alternative_names":{"type":"boolean"},"show_lat_lng":{"type":"boolean"}},"type":"object"}},"type":"object"},"custom-data-type-geonames":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"},"geonames_username":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-gnd":{"properties":{"config":{"properties":{"days":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-gvk":{"properties":{"config":{"properties":{"days":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-html-editor":{"properties":{"config":{"properties":{"custom_css_url":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-iconclass":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-iucn":{"properties":{"config":{"properties":{"api_token":{"type":"string"},"api_url":{"type":"string"},"days":{"type":"integer"},"easydb_login":{"type":"string"},"easydb_password":{"type":"string"},"iucn_fields":{"items":{"properties":{"iucn_field_name":{"type":"string"}},"type":"object"},"type":"array"},"tag_red":{"type":"integer"},"tag_unclear":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-link":{"properties":{"config":{"properties":{"templates":{"items":{"properties":{"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"name":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"placeholders":{"items":{"properties":{"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"key":{"type":"string"}},"type":"object"},"type":"array"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-auto-keyworder-plugin":{"properties":{"config":{"properties":{"configs":{"items":{"properties":{"api_key":{"type":"string"},"asset_field":{"type":"string"},"asset_version":{"type":"string"},"config_enabled":{"type":"boolean"},"keyword_categories_field":{"type":"string"},"keyword_color_field":{"type":"string"},"keyword_gender_field":{"type":"string"},"keyword_material_field":{"type":"string"},"keyword_quantity_field":{"type":"string"},"language":{"enum":["ar","cs-CZ","de-DE","en-US","es-ES","fa","fr-FR","it-IT","ja-Jpan","ka-GE","ko-Kore","nl-NL","pl-PL","ru-RU","zh-Hans"],"type":"string"},"min_age_days":{"type":"integer"},"name":{"type":"string"},"objecttype":{"type":"string"},"service":{"enum":["Cloudsight.ai"],"type":"string"},"subject_field":{"type":"string"},"tagfilter":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"},"timestamp_field":{"type":"string"}},"type":"object"},"type":"array"},"easydb_password":{"type":"string"},"easydb_session_token":{"type":"string"},"easydb_user":{"type":"string"},"enabled":{"type":"boolean"},"request_status_delay":{"type":"integer"},"request_status_repititions":{"type":"integer"},"start_now":{"type":"boolean"}},"type":"object"}},"type":"object"},"easydb-connector-plugin":{"properties":{"config":{"properties":{"easydb_id":{"type":"string"},"easydbs":{"items":{"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"enable":{"type":"boolean"},"https_insecure":{"type":"boolean"},"login":{"type":"string"},"name":{"type":"string"},"password":{"type":"string"},"timeout_sec":{"type":"integer"},"url":{"type":"string"}},"type":"object"},"type":"array"},"enable_all":{"type":"boolean"},"objecttype":{"type":"string"},"table_id":{"type":"string"},"table_name":{"type":"string"},"table_ref_col":{"type":"string"},"url":{"type":"string"}},"type":"object"}},"type":"object"},"easydb-detail-map-plugin":{"properties":{"config":{"properties":{"enabled":{"type":"boolean"},"mapboxToken":{"type":"string"},"tiles":{"enum":["Mapbox","OpenStreetMaps"],"type":"string"}},"type":"object"}},"type":"object"},"easydb-drupal-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"}},"type":"object"}},"type":"object"},"easydb-easydb4migration-plugin":{"properties":{"config":{"properties":{"fylr_inst":{"type":"string"},"fylr_uid":{"type":"string"},"fylr_url":{"type":"string"}},"type":"object"}},"type":"object"},"easydb-editor-tagfilter-defaults-plugin":{"properties":{"config":{"properties":{"filters":{"items":{"properties":{"default":{"type":"string"},"mask_id":{"type":"integer"},"operation":{"items":{"enum":["insert","update"],"type":"string"},"type":"array"},"pool_id":{"type":"string"},"tagfilter":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-falconio-plugin":{"properties":{"config":{"properties":{"fio_instances":{"items":{"properties":{"active":{"type":"boolean"},"auth":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-remote-plugin":{"properties":{"config":{"properties":{"instances":{"items":{"properties":{"css_url":{"type":"string"},"js_url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-typo3-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"profile_mapping":{"type":"integer"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"}},"type":"object"}},"type":"object"},"easydb-wordpress-plugin":{"properties":{"config":{"properties":{"wp_instances":{"items":{"properties":{"auth":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"example-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"bool":{"type":"boolean"},"date":{"type":"string"},"easydb_group":{"type":"integer"},"email":{"format":"email","type":"string"},"example_base_config":{"type":"string"},"int":{"type":"integer"},"profile_mapping":{"type":"integer"},"select":{"enum":["apple","banana","kiwi"],"type":"string"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"},"string_list":{"items":{"enum":["one","three","two"],"type":"string"},"type":"array"},"string_list_sort":{"items":{"enum":["one","three","two"],"type":"string"},"type":"array"},"tag_select":{"items":{"type":"integer"},"type":"object","x-type":"tag-select"},"tagfilter_select":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"},"text":{"type":"string"},"text_l10n":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"text_l10n_multi":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"text_multi":{"type":"string"},"webhook_secret":{"type":"string"}},"type":"object"}},"type":"object"},"fylr_example":{"properties":{"config":{"properties":{"data":{"type":"object","x-type":"json"},"on_off":{"type":"boolean"},"value":{"type":"string"}},"type":"object"}},"type":"object"},"pdf-creator":{"properties":{"config":{"properties":{"custom_css_url":{"type":"string"},"fylr_url":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"system":{"properties":{"config":{"properties":{"appearance":{"properties":{"background_color":{"type":"string"},"brand_color":{"type":"string"},"favicon":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"login_background":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"logo":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"logo_external_url":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"tag_colors":{"items":{"properties":{"tag_color":{"type":"string"}},"type":"object"},"type":"array"},"tag_icons":{"items":{"properties":{"fa-icon":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"colorprofiles":{"properties":{"profiles":{"items":{"properties":{"profile":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"profilename":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"custom_data_type_updater":{"properties":{"active":{"type":"boolean"}},"type":"object"},"deep_link_access":{"properties":{"allow_access_by_column":{"type":"boolean"},"allow_access_by_id":{"type":"boolean"},"enabled":{"type":"boolean"},"iiif_default_links":{"type":"boolean"},"iiif_links":{"items":{"properties":{"html_code":{"type":"string"},"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"iiif_required_statement":{"properties":{"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"value":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"include_parents":{"type":"boolean"},"merge_linked_objects":{"enum":["all","none","not_in_main_search","not_in_main_search_unless_reverse"],"type":"string"},"merge_max_depth":{"type":"integer"}},"type":"object"},"detail_deep_link":{"properties":{"use_system_object_id":{"type":"boolean"}},"type":"object"},"email":{"properties":{"admin_emails":{"items":{"properties":{"email":{"format":"email","type":"string"}},"type":"object"},"type":"array"},"from":{"format":"email","type":"string"},"signature":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"email_server":{"properties":{"cram_md5_auth":{"properties":{"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"helo_domain":{"type":"string"},"insecure_skip_verify":{"type":"boolean"},"login_auth":{"properties":{"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"plain_auth":{"properties":{"identity":{"type":"string"},"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"server_addr":{"type":"string"},"type":{"enum":["off","starttls","tls"],"type":"string"}},"type":"object"},"export":{"properties":{"xslts":{"items":{"properties":{"description":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"namespace":{"type":"string"},"oai_pmh_prefix":{"type":"string"},"schema":{"type":"string"},"use_for_api_objects":{"type":"boolean"},"use_for_oai_pmh":{"type":"boolean"},"xslt":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"}},"type":"object"},"type":"array"}},"type":"object"},"export_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"file_url_expire":{"properties":{"deep_link_days":{"type":"integer"},"default_days":{"type":"integer"},"max_days":{"type":"integer"},"oai_pmh_days":{"type":"integer"}},"type":"object"},"janitor":{"properties":{"active":{"type":"boolean"},"event_remote_addr_expire_days":{"type":"integer"},"events":{"properties":{"expire_days_ADMIN":{"type":"integer"},"expire_days_DOWNLOAD":{"type":"integer"},"expire_days_EXPORT":{"type":"integer"},"expire_days_FRONTEND":{"type":"integer"},"expire_days_INDEX":{"type":"integer"},"expire_days_LOGIN_LOGOUT":{"type":"integer"},"expire_days_PLUGIN":{"type":"integer"},"expire_days_SYSTEM":{"type":"integer"},"expire_days_UPLOAD":{"type":"integer"}},"type":"object"},"file_expire_days":{"type":"integer"},"users":{"properties":{"archive_nonactive_after_days":{"type":"integer"},"archive_types":{"items":{"enum":["anonymous","easydb","easydb_self_register","ldap","sso"],"type":"string"},"type":"array"},"delete_archived_after_days":{"type":"integer"}},"type":"object"}},"type":"object"},"languages":{"properties":{"database":{"items":{"properties":{"date_format":{"enum":["ca","cldr","da","de","us"],"type":"string"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"number_format":{"enum":["ca","cldr","de","fi","it","us"],"type":"string"},"time_format":{"enum":["cldr","da","de","us"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"frontend":{"items":{"enum":["da-DK","de-DE","en-US","fi-FI","fr-FR","it-IT","ru-RU","sv-SE","uz-UZ"],"type":"string"},"type":"array"}},"type":"object"},"ldap":{"properties":{"bindpassword":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"bindusername":{"type":"string"},"connections":{"items":{"properties":{"tls_ca_cert":{"type":"string"},"tls_insecure":{"type":"boolean"},"tls_start":{"type":"boolean"},"url":{"type":"string"}},"type":"object"},"type":"array"},"debug":{"type":"boolean"},"groupbasedn":{"type":"string"},"groupfilter":{"type":"string"},"groupmapping":{"items":{"properties":{"group":{"type":"string"}},"type":"object"},"type":"array"},"userbasedn":{"type":"string"},"userfilter":{"type":"string"},"usermapping":{"items":{"properties":{"key":{"enum":["company","department","displayname","email","first_name","last_name","login","phone","reference"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"userupdatecolumn":{"enum":["email","login","reference"],"type":"string"}},"type":"object"},"license":{"properties":{"license":{"$ref":"#/components/schemas/License"}},"type":"object"},"loca":{"properties":{"google_csv":{"items":{"properties":{"gid":{"type":"integer"},"key":{"type":"string"}},"type":"object"},"type":"array"},"google_overload_csv":{"type":"boolean"}},"type":"object"},"location_defaults":{"properties":{"backups":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"},"originals":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"},"versions":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"}},"type":"object"},"logging":{"properties":{"level":{"enum":["","debug","error","info","trace","warn"],"type":"string"},"timings":{"type":"boolean"}},"type":"object"},"login":{"properties":{"guest":{"type":"boolean"},"info":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"placeholder":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"name":{"properties":{"description":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"internal_name":{"type":"string"},"title":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"notification_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"oai_pmh":{"properties":{"admin_email":{"items":{"properties":{"email":{"format":"email","type":"string"}},"type":"object"},"type":"array"},"enabled":{"type":"boolean"},"include_parents":{"type":"boolean"},"merge_linked_objects":{"enum":["all","none","not_in_main_search","not_in_main_search_unless_reverse"],"type":"string"},"merge_max_depth":{"type":"integer"},"namespace_identifier":{"type":"string"},"records_limit":{"type":"integer"},"repository_name":{"type":"string"},"tagfilter_sets":{"items":{"properties":{"set_name":{"type":"string"},"tagfilter":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"oauth2":{"properties":{"clients":{"items":{"properties":{"name":{"type":"string"},"redirect_uris":{"items":{"properties":{"url":{"type":"string"}},"type":"object"},"type":"array"},"secret":{"type":"string"}},"type":"object"},"type":"array"},"expirations":{"properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"}},"type":"object"}},"type":"object"},"objectstore":{"properties":{"instance":{"type":"string"},"server":{"type":"string"},"uid":{"type":"string"}},"type":"object"},"openapi_spec_endpoint":{"properties":{"active":{"type":"boolean"}},"type":"object"},"openid":{"properties":{"userinfo":{"items":{"enum":["address_supplement","company","country","department","displayname","email","first_name","house_number","last_name","phone","postal_code","state","street","town"],"type":"string"},"type":"array"}},"type":"object"},"password":{"properties":{"check":{"items":{"properties":{"regexp":{"type":"string"}},"type":"object"},"type":"array"},"hint":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"showforgot":{"type":"boolean"}},"type":"object"},"plugin_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"produce_config":{"properties":{"value":{"properties":{"classes":{"description":"The produce config defines the renditions (preview versions) produce by the file workers. It includes the parameters for the recipes and defines file extension based routing.","properties":{"audio":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"audioconverter:convert\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format [select]","enum":["aac"],"type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"audioconverter:convert\"","type":"string"}},"type":"object"},{"description":"Recipe \"audioconverter:preview\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"audioconverter:preview\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"image":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"fylr_example:example_image:grayPy\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"fylr_example:example_image:grayPy\"","type":"string"}},"type":"object"},{"description":"Recipe \"fylr_example:example_image:grayIM\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"fylr_example:example_image:grayIM\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:browserthumbs\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"background":{"description":"For background color, defaults to black (if no Alpha channel is available). [select]","enum":["","black","white"],"type":"string"},"clip":{"description":"When converting TIFF to PNG use embedded clipping path to remove background. [bool]","type":"boolean"},"colorprofile":{"description":" [select]","enum":["","ACESCG Linear","AdobeRGB1998","DCI(P3) RGB","Display P3","Generic CMYK Profile","Generic Gray Gamma 2.2 Profile","Generic Gray Profile","Generic Lab Profile","Generic RGB Profile","Generic XYZ Profile","ISOcoated_v2_eci","ITU-2020","ITU-709","ROMM RGB","eciRGB_v2","sRGB Profile","sRGB_IEC61966-2-1_black_scaled"],"type":"string"},"colorspace":{"description":" [select]","enum":["","cmyk","srgb"],"type":"string"},"enlarge":{"description":"Enlarge output if the original is smaller than the requested size [bool]","type":"boolean"},"format":{"description":"Output format of the thumbnail. [select]","enum":["jpg","png"],"type":"string"},"jpegquality":{"description":"JPEG quality: 1 (worst) to 100 (best). Use 0 to not explicitely set quality. [int]","type":"integer"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"Set the output size. Use 0 to keep the original size. [int]","type":"integer"},"size_minimum":{"description":"Only produce version if source size is greater or equal size_minimum. [int]","type":"integer"},"strip":{"description":"Strip metadata from thumbnail. [bool]","type":"boolean"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:browserthumbs\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:preview_pool_watermark\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"},"size_minimum":{"description":"only produce version if source size is greater or equal size_minimum [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:preview_pool_watermark\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:vectortosvg\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","eps","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","eps","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:vectortosvg\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"office":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["csv","doc","docx","odp","ods","odt","otf","pdf","ppt","pptx","rtf","ttf","txt","xls","xlsx"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"officeconverter:browserthumbs\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["pdf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["pdf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:browserthumbs\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:font\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["otf","ttf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["otf","ttf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"size":{"description":"set the output size. This will produce a squared preview [int]","type":"integer"},"text":{"description":"text to render on the preview [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:font\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:pdf\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:pdf\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:preview\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:preview\"","type":"string"}},"type":"object"},{"description":"Recipe \"pdfconverter:pdfpages\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["pdf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["pdf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"pdfconverter:pdfpages\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"video":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"videoconverter:resize\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"ffmpeg_params":{"description":"additional ffmpeg options for the video production [string]","type":"string"},"height":{"description":"set the output height [int]","type":"integer"},"height_minimum":{"description":"only produce version if source height is greater or equal height_minimum [int]","type":"integer"},"timeout":{"description":"maximum duration to encode the video, e.g. \"1m\" or \"1h\" [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"videoconverter:resize\"","type":"string"}},"type":"object"},{"description":"Recipe \"videoconverter:thumbnail\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"set the format of the target. [select]","enum":["jpg","png"],"type":"string"},"size":{"description":"set the target size (eg 128) [string]","type":"string"},"timeout":{"description":"maximum duration to produce the thumbnail, e.g. \"1m\" or \"1h\" [string]","type":"string"},"video-thumb-select":{"description":"\"hh:mm:ss.sss\", \"ss.sss\", \"auto\" or \"no-ffmpegthumbnailer\".\n [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"videoconverter:thumbnail\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"}},"type":"object"},"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the original or version matches.","items":{"enum":["3gp","aac","ai","aiff","arw","asf","avi","bmp","cr2","crw","csv","dng","doc","docx","dts","eps","flac","flv","gif","heic","hevc","ico","jfif","jp2","jpeg","jpg","m2v","m4a","m4v","mjpeg","mkv","mov","mp2","mp3","mp4","mpeg","mpg","mts","mxf","nef","odp","ods","odt","oga","ogg","ogv","opus","otf","pdf","png","ppm","ppt","pptx","psd","ra","raf","rm","rtf","rw2","svg","swf","tif","tiff","ts","ttf","txt","vob","wav","webm","webp","wma","wmf","wmv","wtv","xls","xlsx"],"type":"string"},"type":"array"},"includeversions":{"description":"If set, the custom metadata is produces not only for originals but also for all versions.","type":"boolean"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"uploadallowunknown":{"description":"If set, the upload of file types which are not enabled in any \"uploadenabledextensions\", is allowed.","type":"boolean"},"uploadmaxfilesize":{"description":"The upload maximum file size (can be overwritten by each class), given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"}},"type":"object","x-type":"json"}},"type":"object"},"publish":{"properties":{"collectors":{"items":{"properties":{"display_format":{"enum":["name","name_type","name_type_doi","type"],"type":"string"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"internalname":{"type":"string"},"logo":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"prefix":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"purge":{"properties":{"allow_purge":{"type":"boolean"},"purge_storage":{"type":"boolean"}},"type":"object"},"register":{"properties":{"enable":{"type":"boolean"},"form":{"properties":{"address":{"enum":["hide","require","show"],"type":"string"},"company":{"enum":["hide","require","show"],"type":"string"},"department":{"enum":["hide","require","show"],"type":"string"},"displayname":{"enum":["hide","require","show"],"type":"string"},"first_name":{"enum":["hide","require","show"],"type":"string"},"last_name":{"enum":["hide","require","show"],"type":"string"},"phone":{"enum":["hide","require","show"],"type":"string"}},"type":"object"},"groups":{"items":{"properties":{"group":{"type":"integer"}},"type":"object"},"type":"array"},"info":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"saml":{"properties":{"cert":{"type":"string"},"debug":{"type":"boolean"},"groupmapping":{"items":{"properties":{"group":{"type":"string"}},"type":"object"},"type":"array"},"key":{"type":"string"},"ldap":{"properties":{"bindpassword":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"bindusername":{"type":"string"},"connections":{"items":{"properties":{"tls_ca_cert":{"type":"string"},"tls_insecure":{"type":"boolean"},"tls_start":{"type":"boolean"},"url":{"type":"string"}},"type":"object"},"type":"array"},"groupbasedn":{"type":"string"},"groupfilter":{"type":"string"}},"type":"object"},"loginlink":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"loginpreferred":{"type":"boolean"},"signrequest":{"enum":["","sha1","sha256","sha512"],"type":"string"},"url":{"type":"string"},"usermapping":{"items":{"properties":{"key":{"enum":["company","department","displayname","email","first_name","last_name","login","phone","reference"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"userupdatecolumn":{"enum":["email","login","reference"],"type":"string"}},"type":"object"},"transition_webhook":{"properties":{"webhooks":{"items":{"properties":{"include_access_token":{"type":"boolean"},"name":{"type":"string"},"secret":{"type":"string"},"send_authorization_header":{"type":"boolean"},"timeout":{"type":"integer"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"user":{"properties":{"copy_to_event":{"items":{"enum":["address_supplement","company","country","department","first_name","house_number","last_name","login","phone","postal_code","reference","state","street","town"],"type":"string"},"type":"array"},"default_delete_policy":{"enum":["archive","ask","delete"],"type":"string"},"user_in_event_group":{"items":{"enum":["ADMIN","DOWNLOAD","EXPORT","FRONTEND","LOGIN_LOGOUT","PLUGIN","SYSTEM","UPLOAD"],"type":"string"},"type":"array"}},"type":"object"},"webdav":{"properties":{"hotfolder":{"type":"boolean"},"hotfolder_wait_sec":{"type":"integer"},"read_write_access":{"type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"plugin":{"properties":{"ai-metadata":{"properties":{"config":{"properties":{"apikey":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"debug":{"type":"boolean"},"fields":{"items":{"properties":{"name":{"type":"string"},"question":{"type":"string"},"type":{"enum":["list","localized","localized list","text"],"type":"string"}},"type":"object"},"type":"array"},"upload_file_size":{"enum":["big","medium","small"],"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-dante":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-gazetteer":{"properties":{"config":{"properties":{"days":{"type":"integer"},"enabled":{"type":"boolean"},"field_from":{"type":"string"},"field_to":{"type":"string"},"objecttype":{"type":"string"},"on_update":{"type":"boolean"},"show_alternative_names":{"type":"boolean"},"show_lat_lng":{"type":"boolean"}},"type":"object"}},"type":"object"},"custom-data-type-geonames":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"},"geonames_username":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-gnd":{"properties":{"config":{"properties":{"days":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-gvk":{"properties":{"config":{"properties":{"days":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-html-editor":{"properties":{"config":{"properties":{"custom_css_url":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-iconclass":{"properties":{"config":{"properties":{"days":{"type":"integer"},"default_language":{"type":"string"}},"type":"object"}},"type":"object"},"custom-data-type-iucn":{"properties":{"config":{"properties":{"api_token":{"type":"string"},"api_url":{"type":"string"},"days":{"type":"integer"},"easydb_login":{"type":"string"},"easydb_password":{"type":"string"},"iucn_fields":{"items":{"properties":{"iucn_field_name":{"type":"string"}},"type":"object"},"type":"array"},"tag_red":{"type":"integer"},"tag_unclear":{"type":"integer"}},"type":"object"}},"type":"object"},"custom-data-type-link":{"properties":{"config":{"properties":{"templates":{"items":{"properties":{"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"name":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"placeholders":{"items":{"properties":{"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"key":{"type":"string"}},"type":"object"},"type":"array"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-auto-keyworder-plugin":{"properties":{"config":{"properties":{"configs":{"items":{"properties":{"api_key":{"type":"string"},"asset_field":{"type":"string"},"asset_version":{"type":"string"},"config_enabled":{"type":"boolean"},"keyword_categories_field":{"type":"string"},"keyword_color_field":{"type":"string"},"keyword_gender_field":{"type":"string"},"keyword_material_field":{"type":"string"},"keyword_quantity_field":{"type":"string"},"language":{"enum":["ar","cs-CZ","de-DE","en-US","es-ES","fa","fr-FR","it-IT","ja-Jpan","ka-GE","ko-Kore","nl-NL","pl-PL","ru-RU","zh-Hans"],"type":"string"},"min_age_days":{"type":"integer"},"name":{"type":"string"},"objecttype":{"type":"string"},"service":{"enum":["Cloudsight.ai"],"type":"string"},"subject_field":{"type":"string"},"tagfilter":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"},"timestamp_field":{"type":"string"}},"type":"object"},"type":"array"},"easydb_password":{"type":"string"},"easydb_session_token":{"type":"string"},"easydb_user":{"type":"string"},"enabled":{"type":"boolean"},"request_status_delay":{"type":"integer"},"request_status_repititions":{"type":"integer"},"start_now":{"type":"boolean"}},"type":"object"}},"type":"object"},"easydb-connector-plugin":{"properties":{"config":{"properties":{"easydb_id":{"type":"string"},"easydbs":{"items":{"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"enable":{"type":"boolean"},"https_insecure":{"type":"boolean"},"login":{"type":"string"},"name":{"type":"string"},"password":{"type":"string"},"timeout_sec":{"type":"integer"},"url":{"type":"string"}},"type":"object"},"type":"array"},"enable_all":{"type":"boolean"},"objecttype":{"type":"string"},"table_id":{"type":"string"},"table_name":{"type":"string"},"table_ref_col":{"type":"string"},"url":{"type":"string"}},"type":"object"}},"type":"object"},"easydb-detail-map-plugin":{"properties":{"config":{"properties":{"enabled":{"type":"boolean"},"mapboxToken":{"type":"string"},"tiles":{"enum":["Mapbox","OpenStreetMaps"],"type":"string"}},"type":"object"}},"type":"object"},"easydb-drupal-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"}},"type":"object"}},"type":"object"},"easydb-easydb4migration-plugin":{"properties":{"config":{"properties":{"fylr_inst":{"type":"string"},"fylr_uid":{"type":"string"},"fylr_url":{"type":"string"}},"type":"object"}},"type":"object"},"easydb-editor-tagfilter-defaults-plugin":{"properties":{"config":{"properties":{"filters":{"items":{"properties":{"default":{"type":"string"},"mask_id":{"type":"integer"},"operation":{"items":{"enum":["insert","update"],"type":"string"},"type":"array"},"pool_id":{"type":"string"},"tagfilter":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-falconio-plugin":{"properties":{"config":{"properties":{"fio_instances":{"items":{"properties":{"active":{"type":"boolean"},"auth":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-remote-plugin":{"properties":{"config":{"properties":{"instances":{"items":{"properties":{"css_url":{"type":"string"},"js_url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"easydb-typo3-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"profile_mapping":{"type":"integer"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"}},"type":"object"}},"type":"object"},"easydb-wordpress-plugin":{"properties":{"config":{"properties":{"wp_instances":{"items":{"properties":{"auth":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"example-plugin":{"properties":{"config":{"properties":{"active":{"type":"boolean"},"bool":{"type":"boolean"},"date":{"type":"string"},"easydb_group":{"type":"integer"},"email":{"format":"email","type":"string"},"example_base_config":{"type":"string"},"int":{"type":"integer"},"profile_mapping":{"type":"integer"},"select":{"enum":["apple","banana","kiwi"],"type":"string"},"send_files":{"type":"boolean"},"send_files_max_filesize":{"type":"integer"},"string_list":{"items":{"enum":["one","three","two"],"type":"string"},"type":"array"},"string_list_sort":{"items":{"enum":["one","three","two"],"type":"string"},"type":"array"},"tag_select":{"items":{"type":"integer"},"type":"object","x-type":"tag-select"},"tagfilter_select":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"},"text":{"type":"string"},"text_l10n":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"text_l10n_multi":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"text_multi":{"type":"string"},"webhook_secret":{"type":"string"}},"type":"object"}},"type":"object"},"fylr_example":{"properties":{"config":{"properties":{"data":{"type":"object","x-type":"json"},"on_off":{"type":"boolean"},"value":{"type":"string"}},"type":"object"}},"type":"object"},"pdf-creator":{"properties":{"config":{"properties":{"custom_css_url":{"type":"string"},"fylr_url":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"system":{"properties":{"config":{"properties":{"appearance":{"properties":{"background_color":{"type":"string"},"brand_color":{"type":"string"},"favicon":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"login_background":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"logo":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"logo_external_url":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"tag_colors":{"items":{"properties":{"tag_color":{"type":"string"}},"type":"object"},"type":"array"},"tag_icons":{"items":{"properties":{"fa-icon":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"colorprofiles":{"properties":{"profiles":{"items":{"properties":{"profile":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"profilename":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"custom_data_type_updater":{"properties":{"active":{"type":"boolean"}},"type":"object"},"deep_link_access":{"properties":{"allow_access_by_column":{"type":"boolean"},"allow_access_by_id":{"type":"boolean"},"enabled":{"type":"boolean"},"iiif_default_links":{"type":"boolean"},"iiif_links":{"items":{"properties":{"html_code":{"type":"string"},"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"iiif_required_statement":{"properties":{"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"value":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"include_parents":{"type":"boolean"},"merge_linked_objects":{"enum":["all","none","not_in_main_search","not_in_main_search_unless_reverse"],"type":"string"},"merge_max_depth":{"type":"integer"}},"type":"object"},"detail_deep_link":{"properties":{"use_system_object_id":{"type":"boolean"}},"type":"object"},"email":{"properties":{"admin_emails":{"items":{"properties":{"email":{"format":"email","type":"string"}},"type":"object"},"type":"array"},"from":{"format":"email","type":"string"},"signature":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"email_server":{"properties":{"cram_md5_auth":{"properties":{"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"helo_domain":{"type":"string"},"insecure_skip_verify":{"type":"boolean"},"login_auth":{"properties":{"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"plain_auth":{"properties":{"identity":{"type":"string"},"password":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"username":{"type":"string"}},"type":"object"},"server_addr":{"type":"string"},"type":{"enum":["off","starttls","tls"],"type":"string"}},"type":"object"},"export":{"properties":{"xslts":{"items":{"properties":{"description":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"namespace":{"type":"string"},"oai_pmh_prefix":{"type":"string"},"schema":{"type":"string"},"use_for_api_objects":{"type":"boolean"},"use_for_oai_pmh":{"type":"boolean"},"xslt":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"}},"type":"object"},"type":"array"}},"type":"object"},"export_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"file_url_expire":{"properties":{"deep_link_days":{"type":"integer"},"default_days":{"type":"integer"},"max_days":{"type":"integer"},"oai_pmh_days":{"type":"integer"}},"type":"object"},"janitor":{"properties":{"active":{"type":"boolean"},"event_remote_addr_expire_days":{"type":"integer"},"events":{"properties":{"expire_days_ADMIN":{"type":"integer"},"expire_days_DOWNLOAD":{"type":"integer"},"expire_days_EXPORT":{"type":"integer"},"expire_days_FRONTEND":{"type":"integer"},"expire_days_INDEX":{"type":"integer"},"expire_days_LOGIN_LOGOUT":{"type":"integer"},"expire_days_PLUGIN":{"type":"integer"},"expire_days_SYSTEM":{"type":"integer"},"expire_days_UPLOAD":{"type":"integer"}},"type":"object"},"file_expire_days":{"type":"integer"},"users":{"properties":{"archive_nonactive_after_days":{"type":"integer"},"archive_types":{"items":{"enum":["anonymous","easydb","easydb_self_register","ldap","sso"],"type":"string"},"type":"array"},"delete_archived_after_days":{"type":"integer"}},"type":"object"}},"type":"object"},"languages":{"properties":{"database":{"items":{"properties":{"date_format":{"enum":["ca","cldr","da","de","us"],"type":"string"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"number_format":{"enum":["ca","cldr","de","fi","it","us"],"type":"string"},"time_format":{"enum":["cldr","da","de","us"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"frontend":{"items":{"enum":["da-DK","de-DE","en-US","fi-FI","fr-FR","it-IT","ru-RU","sv-SE","uz-UZ"],"type":"string"},"type":"array"}},"type":"object"},"ldap":{"properties":{"bindpassword":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"bindusername":{"type":"string"},"connections":{"items":{"properties":{"tls_ca_cert":{"type":"string"},"tls_insecure":{"type":"boolean"},"tls_start":{"type":"boolean"},"url":{"type":"string"}},"type":"object"},"type":"array"},"debug":{"type":"boolean"},"groupbasedn":{"type":"string"},"groupfilter":{"type":"string"},"groupmapping":{"items":{"properties":{"group":{"type":"string"}},"type":"object"},"type":"array"},"userbasedn":{"type":"string"},"userfilter":{"type":"string"},"usermapping":{"items":{"properties":{"key":{"enum":["company","department","displayname","email","first_name","last_name","login","phone","reference"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"userupdatecolumn":{"enum":["email","login","reference"],"type":"string"}},"type":"object"},"license":{"properties":{"license":{"$ref":"#/components/schemas/License"}},"type":"object"},"loca":{"properties":{"google_csv":{"items":{"properties":{"gid":{"type":"integer"},"key":{"type":"string"}},"type":"object"},"type":"array"},"google_overload_csv":{"type":"boolean"}},"type":"object"},"location_defaults":{"properties":{"backups":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"},"originals":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"},"versions":{"description":"Name of storage location as defined in the location manager","enum":["file","s3"],"nullable":true,"type":"string"}},"type":"object"},"logging":{"properties":{"level":{"enum":["","debug","error","info","trace","warn"],"type":"string"},"timings":{"type":"boolean"}},"type":"object"},"login":{"properties":{"guest":{"type":"boolean"},"info":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"label":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"placeholder":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"name":{"properties":{"description":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"internal_name":{"type":"string"},"title":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"notification_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"oai_pmh":{"properties":{"admin_email":{"items":{"properties":{"email":{"format":"email","type":"string"}},"type":"object"},"type":"array"},"enabled":{"type":"boolean"},"include_parents":{"type":"boolean"},"merge_linked_objects":{"enum":["all","none","not_in_main_search","not_in_main_search_unless_reverse"],"type":"string"},"merge_max_depth":{"type":"integer"},"namespace_identifier":{"type":"string"},"records_limit":{"type":"integer"},"repository_name":{"type":"string"},"tagfilter_sets":{"items":{"properties":{"set_name":{"type":"string"},"tagfilter":{"description":"Tag filter definition with any, all and not","properties":{"all":{"items":{"description":"List of tag ids which are all required","enum":[1,2,3,4],"type":"integer"},"type":"array"},"any":{"items":{"description":"List of tag ids of which at least one is required to match","enum":[1,2,3,4],"type":"integer"},"type":"array"},"not":{"items":{"description":"List of tag ids which must not match","enum":[1,2,3,4],"type":"integer"},"type":"array"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"oauth2":{"properties":{"clients":{"items":{"properties":{"name":{"type":"string"},"redirect_uris":{"items":{"properties":{"url":{"type":"string"}},"type":"object"},"type":"array"},"secret":{"type":"string"}},"type":"object"},"type":"array"},"expirations":{"properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"}},"type":"object"}},"type":"object"},"objectstore":{"properties":{"instance":{"type":"string"},"server":{"type":"string"},"uid":{"type":"string"}},"type":"object"},"openapi_spec_endpoint":{"properties":{"active":{"type":"boolean"}},"type":"object"},"openid":{"properties":{"userinfo":{"items":{"enum":["address_supplement","company","country","department","displayname","email","first_name","house_number","last_name","phone","postal_code","state","street","town"],"type":"string"},"type":"array"}},"type":"object"},"password":{"properties":{"check":{"items":{"properties":{"regexp":{"type":"string"}},"type":"object"},"type":"array"},"hint":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"showforgot":{"type":"boolean"}},"type":"object"},"plugin_scheduler":{"properties":{"active":{"type":"boolean"}},"type":"object"},"produce_config":{"properties":{"value":{"properties":{"classes":{"description":"The produce config defines the renditions (preview versions) produce by the file workers. It includes the parameters for the recipes and defines file extension based routing.","properties":{"audio":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"audioconverter:preview\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"audioconverter:preview\"","type":"string"}},"type":"object"},{"description":"Recipe \"audioconverter:convert\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["aac","aiff","dts","flac","m4a","mp2","mp3","oga","ogg","opus","ra","wav","wma"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format [select]","enum":["aac"],"type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"audioconverter:convert\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"image":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"fylr_example:example_image:grayIM\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"fylr_example:example_image:grayIM\"","type":"string"}},"type":"object"},{"description":"Recipe \"fylr_example:example_image:grayPy\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"fylr_example:example_image:grayPy\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:browserthumbs\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"background":{"description":"For background color, defaults to black (if no Alpha channel is available). [select]","enum":["","black","white"],"type":"string"},"clip":{"description":"When converting TIFF to PNG use embedded clipping path to remove background. [bool]","type":"boolean"},"colorprofile":{"description":" [select]","enum":["","ACESCG Linear","AdobeRGB1998","DCI(P3) RGB","Display P3","Generic CMYK Profile","Generic Gray Gamma 2.2 Profile","Generic Gray Profile","Generic Lab Profile","Generic RGB Profile","Generic XYZ Profile","ISOcoated_v2_eci","ITU-2020","ITU-709","ROMM RGB","eciRGB_v2","sRGB Profile","sRGB_IEC61966-2-1_black_scaled"],"type":"string"},"colorspace":{"description":" [select]","enum":["","cmyk","srgb"],"type":"string"},"enlarge":{"description":"Enlarge output if the original is smaller than the requested size [bool]","type":"boolean"},"format":{"description":"Output format of the thumbnail. [select]","enum":["jpg","png"],"type":"string"},"jpegquality":{"description":"JPEG quality: 1 (worst) to 100 (best). Use 0 to not explicitely set quality. [int]","type":"integer"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"Set the output size. Use 0 to keep the original size. [int]","type":"integer"},"size_minimum":{"description":"Only produce version if source size is greater or equal size_minimum. [int]","type":"integer"},"strip":{"description":"Strip metadata from thumbnail. [bool]","type":"boolean"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:browserthumbs\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:preview_pool_watermark\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","arw","bmp","cr2","crw","dng","eps","gif","heic","ico","jfif","jp2","jpeg","jpg","nef","png","ppm","psd","raf","rw2","svg","tif","tiff","webp","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"},"size_minimum":{"description":"only produce version if source size is greater or equal size_minimum [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:preview_pool_watermark\"","type":"string"}},"type":"object"},{"description":"Recipe \"imageconverter:vectortosvg\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["ai","eps","wmf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["ai","eps","wmf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"imageconverter:vectortosvg\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"office":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["csv","doc","docx","odp","ods","odt","otf","pdf","ppt","pptx","rtf","ttf","txt","xls","xlsx"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"officeconverter:font\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["otf","ttf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["otf","ttf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"size":{"description":"set the output size. This will produce a squared preview [int]","type":"integer"},"text":{"description":"text to render on the preview [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:font\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:pdf\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:pdf\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:preview\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["csv","doc","docx","odp","ods","odt","ppt","pptx","rtf","txt","xls","xlsx"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"resize_mode":{"description":" [select]","enum":["","height","max","min","width"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:preview\"","type":"string"}},"type":"object"},{"description":"Recipe \"officeconverter:browserthumbs\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["pdf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["pdf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"output format of the thumbnail [select]","enum":["jpg","png"],"type":"string"},"size":{"description":"set the output size. [int]","type":"integer"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"officeconverter:browserthumbs\"","type":"string"}},"type":"object"},{"description":"Recipe \"pdfconverter:pdfpages\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["pdf"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["pdf"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"type":"object"},"recipename":{"description":"This oneOf block is for \"pdfconverter:pdfpages\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"},"video":{"properties":{"name":{"description":"Read-only value with the name of the class.","type":"string"},"rightsmanagement":{"description":"If set, this version will be configurable in the rights management of fylr.","type":"boolean"},"sourceversion":{"description":"The version which is used to produce this version.","type":"string"},"standard":{"description":"If set, this version will be included in the standard info.","type":"boolean"},"uploadenabledextensions":{"items":{"description":"Extensions which are allowed in this class for upload.","enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"uploadmaxfilesize":{"description":"The upload maximum file size for this class, given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"},"versions":{"items":{"oneOf":[{"description":"Recipe \"videoconverter:resize\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"ffmpeg_params":{"description":"additional ffmpeg options for the video production [string]","type":"string"},"height":{"description":"set the output height [int]","type":"integer"},"height_minimum":{"description":"only produce version if source height is greater or equal height_minimum [int]","type":"integer"},"timeout":{"description":"maximum duration to encode the video, e.g. \"1m\" or \"1h\" [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"videoconverter:resize\"","type":"string"}},"type":"object"},{"description":"Recipe \"videoconverter:thumbnail\"","properties":{"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the version matches.","items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"displayname":{"$ref":"#/components/schemas/lang"},"extensions":{"items":{"enum":["3gp","asf","avi","flv","hevc","m2v","m4v","mjpeg","mkv","mov","mp4","mpeg","mpg","mts","mxf","ogv","rm","swf","ts","vob","webm","wmv","wtv"],"type":"string"},"type":"array"},"group":{"type":"string"},"name":{"type":"string"},"params":{"properties":{"format":{"description":"set the format of the target. [select]","enum":["jpg","png"],"type":"string"},"size":{"description":"set the target size (eg 128) [string]","type":"string"},"timeout":{"description":"maximum duration to produce the thumbnail, e.g. \"1m\" or \"1h\" [string]","type":"string"},"video-thumb-select":{"description":"\"hh:mm:ss.sss\", \"ss.sss\", \"auto\" or \"no-ffmpegthumbnailer\".\n [string]","type":"string"}},"type":"object"},"recipename":{"description":"This oneOf block is for \"videoconverter:thumbnail\"","type":"string"}},"type":"object"}]},"type":"array"},"watermark":{"description":"If set, frontends can use this information to prefer to display a non-watermark version over one with a watermark.","type":"boolean"}},"type":"object"}},"type":"object"},"custommetadata":{"properties":{"extensions":{"description":"If given, only run the custom metadata if the extension of the original or version matches.","items":{"enum":["3gp","aac","ai","aiff","arw","asf","avi","bmp","cr2","crw","csv","dng","doc","docx","dts","eps","flac","flv","gif","heic","hevc","ico","jfif","jp2","jpeg","jpg","m2v","m4a","m4v","mjpeg","mkv","mov","mp2","mp3","mp4","mpeg","mpg","mts","mxf","nef","odp","ods","odt","oga","ogg","ogv","opus","otf","pdf","png","ppm","ppt","pptx","psd","ra","raf","rm","rtf","rw2","svg","swf","tif","tiff","ts","ttf","txt","vob","wav","webm","webp","wma","wmf","wmv","wtv","xls","xlsx"],"type":"string"},"type":"array"},"includeversions":{"description":"If set, the custom metadata is produces not only for originals but also for all versions.","type":"boolean"},"recipename":{"description":"Recipe to process the custom metadata.","enum":["ai-metadata:metadata:chatgpt","fylr_example:example_metadata:example","fylr_example:example_metadata:example-request-only","fylr_example:pdf2text_metadata:pdf2text"],"type":"string"}},"type":"object"},"uploadallowunknown":{"description":"If set, the upload of file types which are not enabled in any \"uploadenabledextensions\", is allowed.","type":"boolean"},"uploadmaxfilesize":{"description":"The upload maximum file size (can be overwritten by each class), given in a format string which ends in \"b\", \"k\", \"m\", \"g\".","type":"string"}},"type":"object","x-type":"json"}},"type":"object"},"publish":{"properties":{"collectors":{"items":{"properties":{"display_format":{"enum":["name","name_type","name_type_doi","type"],"type":"string"},"displayname":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"internalname":{"type":"string"},"logo":{"properties":{"_id":{"description":"The EAS-ID of the file.","type":"integer"},"frontend_prefs":{"additionalProperties":{"description":"Any value is allowed"},"description":"An arbitrary object which is stored alongside with the relation. Make sure your application uses its own top level key in that object and that you do not overwrite existing data (other top level keys).","type":"object"}},"type":"object","x-type":"file"},"prefix":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"purge":{"properties":{"allow_purge":{"type":"boolean"},"purge_storage":{"type":"boolean"}},"type":"object"},"register":{"properties":{"enable":{"type":"boolean"},"form":{"properties":{"address":{"enum":["hide","require","show"],"type":"string"},"company":{"enum":["hide","require","show"],"type":"string"},"department":{"enum":["hide","require","show"],"type":"string"},"displayname":{"enum":["hide","require","show"],"type":"string"},"first_name":{"enum":["hide","require","show"],"type":"string"},"last_name":{"enum":["hide","require","show"],"type":"string"},"phone":{"enum":["hide","require","show"],"type":"string"}},"type":"object"},"groups":{"items":{"properties":{"group":{"type":"integer"}},"type":"object"},"type":"array"},"info":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"}},"type":"object"},"saml":{"properties":{"cert":{"type":"string"},"debug":{"type":"boolean"},"groupmapping":{"items":{"properties":{"group":{"type":"string"}},"type":"object"},"type":"array"},"key":{"type":"string"},"ldap":{"properties":{"bindpassword":{"description":"The string will be encrypted in the server if fylr.encryptionKey is set in fylr.yml. In API responses, if a value is set, the response will always be *** or ***** to indicate that an encrypted value is stored. ***** mean that the value is actually stored encrypted, whereas *** means the value is stored as plain text.","type":"string"},"bindusername":{"type":"string"},"connections":{"items":{"properties":{"tls_ca_cert":{"type":"string"},"tls_insecure":{"type":"boolean"},"tls_start":{"type":"boolean"},"url":{"type":"string"}},"type":"object"},"type":"array"},"groupbasedn":{"type":"string"},"groupfilter":{"type":"string"}},"type":"object"},"loginlink":{"properties":{"de-DE":{"type":"string"},"en-US":{"type":"string"}},"type":"object"},"loginpreferred":{"type":"boolean"},"signrequest":{"enum":["","sha1","sha256","sha512"],"type":"string"},"url":{"type":"string"},"usermapping":{"items":{"properties":{"key":{"enum":["company","department","displayname","email","first_name","last_name","login","phone","reference"],"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"userupdatecolumn":{"enum":["email","login","reference"],"type":"string"}},"type":"object"},"transition_webhook":{"properties":{"webhooks":{"items":{"properties":{"include_access_token":{"type":"boolean"},"name":{"type":"string"},"secret":{"type":"string"},"send_authorization_header":{"type":"boolean"},"timeout":{"type":"integer"},"url":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"user":{"properties":{"copy_to_event":{"items":{"enum":["address_supplement","company","country","department","first_name","house_number","last_name","login","phone","postal_code","reference","state","street","town"],"type":"string"},"type":"array"},"default_delete_policy":{"enum":["archive","ask","delete"],"type":"string"},"user_in_event_group":{"items":{"enum":["ADMIN","DOWNLOAD","EXPORT","FRONTEND","LOGIN_LOGOUT","PLUGIN","SYSTEM","UPLOAD"],"type":"string"},"type":"array"}},"type":"object"},"webdav":{"properties":{"hotfolder":{"type":"boolean"},"hotfolder_wait_sec":{"type":"integer"},"read_write_access":{"type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"The response contains the base configuration values.\n"}},"summary":"Write all base configuration","tags":["config"],"x-path":"config"}},"/config/list":{"get":{"description":"The list is a dynamic compilation of available config varibles. It includes\nfixed config variables of FYLR's base config as well as variables provided\nby plugins.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/config_list"}}},"description":"Success"}},"summary":"Get config list","tags":["config"]}},"/eas/{fileId}":{"description":"The **eas** endpoint is used to upload and download files. Files are an essential part of a **fylr** system. Files and objects are separate entities. In order to use a file, it must be linked to an object by its `ID`. Files cannot be updated, in case of an update a new file `ID` is issued and linked to the updated object.\n","get":{"parameters":[{"in":"path","name":"fileId","required":true,"schema":{"pattern":"^[1-9][0-9]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/file"}}},"description":"The response contains the base configuration values.\n"}},"summary":"Get information about a file"},"post":{"parameters":[{"description":"The ID of the file.","in":"path","name":"fileId","required":true,"schema":{"format":"int64","type":"number"}},{"description":"If set, the call is only checking if the current user is allowed to update the file information.\n","in":"query","name":"permission_check_only","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"custom_produce_config":{"properties":{"overwrites":{"items":{"properties":{"custom":{"additionalProperties":true,"description":"Contains the recipe parameter overwrite.\n","type":"object"},"match":{"description":"If the version matches, the custom parameters overwrite the recipe's parameters. It is mandatory to have at least one parameter set, otherwise this overwrite will be ignored.\n","properties":{"version_class":{"description":"Match the `class` name.\n","type":"string"},"version_name":{"description":"Match the `version`` name.\n","type":"string"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"filename":{"description":"The new filename of the file. It is stored as `original_filepath`.\n","type":"string"},"reference":{"description":"The reference string for the file. Note that the reference is unique across all files in the storage.\n","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"description":"This object is returned for a successful permission check.\n","properties":{"status":{"properties":{"acknowledged":{"enum":["ok"],"type":"string"}},"required":["acknowledged"],"type":"object"}},"required":["status"],"type":"object"},{"description":"The [file](https://docs.fylr.io/for-developers/system-data-types/file) rendering in `standard` format.\n","type":"object"}]}}},"description":"Update was successful.\n"}},"security":[{"BearerAuth":[]}],"summary":"Change information about a file. You need the `RIGHT_ASSET_UPLOAD` right to update the file information."},"x-path":"/eas"},"/settings":{"get":{"description":"This settings endpoint is unprotected and delivers brief information about\nthe running fylr instance. It can also be used to check the current status\nof the running fylr.\n","responses":{"200":{"content":{"application/json":{"schema":{"example":{"build_commit":"b83beb3f03f541c5c2ee8cc58d5bb17bfe4ab2b0","build_commit_time":"2023-03-20T13:35:26Z","config_name":"fylr apitest","external_url":"http://fylr.localhost","index_names":{"BaseRead":"apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-base-1","BaseWrite":"apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-base-1","ObjectRead":"apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-object-1","ObjectWrite":"apitest-fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b-object-1"},"instance":"apitest","name":"fa2c7b27-3430-46cc-97fa-cc3f2eeb1c0b","startup_time":"2023-03-20T15:31:28Z","version":"v6.2.6"},"properties":{"build_commit":{"description":"The GIT commit hash set at compile time.\n","type":"string"},"build_commit_time":{"description":"The UTC timestamp of the GIT commit hash the fylr was built with.\n","type":"string"},"config_name":{"description":"The internal name of the instace, as set in the base configuration.\n","type":"string"},"external_url":{"description":"The url this fylr is reachable under. This is configured in the fylr yaml.\n","type":"string"},"index_names":{"description":"Index names as used in the Elatic indexing system. There is\ntwo indexes for reading (BaseRead \u0026 ObjectRead) and two for\nwriting. New writing indexes are created when a reindex is\nstarted. Once that reindex has finished, the read index is\ndeleted and the read index name becomes the write index name.\nIf these names are identical, the index is up to date.\n","type":"object"},"instance":{"description":"The name of the instance as set in the yaml config file.\n","type":"string"},"name":{"description":"A UID generated when the database is created. The name gets\nre-created when **/api/purge** is used. This name is used as\nprefix for Elastic index names.\n","type":"string"},"startup_time":{"description":"UTC time of when the server was started.","format":"datetime","type":"string"},"version":{"description":"The version of the server. Changed with every release, follows\nsemantic versioning rules.\n","type":"string"},"version_release_date":{"description":"If known, the release date of this **version**. \u003cunreleased\u003e if not yet released.\n","type":"string"}},"type":"object"}}},"description":"Brief information about the running fylr.\n","headers":{"x-fylr-status":{"description":"Current status of the fylr system:\n  * `startup`: Set during startup of fylr. Should rarely be seen.\n  * `reindex`: System is re-indexing. This happens after a `reindex_block` is used during a schema commit.\n    This state is also reached briefly after a regular `reindex`.\n  * `busy`: If too many db connections are open, the system response with `busy`.\n  * `ready`: In this state fylr is ready to answer requests.\n","schema":{"type":"string"}}}}},"summary":"Get all settings","tags":["settings"]}},"/tags":{"get":{"description":"This endpoint returns all available taggroups and tags.\n","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TagGroup"},"type":"array"}}},"description":"Success"}},"summary":"Get all tags","tags":["tags"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TagGroup"},"type":"array"}}},"required":true},"responses":{"200":{"description":"Success"}},"summary":"Create a new tag","tags":["tags"]}}},"tags":[{"name":"config"},{"name":"tags"}],"x-codeSamples":true,"x-hideTryItPanel":true}