You are here

Home » API reference » Search API Synonym 8

searchapi.synonym.export.yml in Search API Synonym 8

console/translations/en/searchapi.synonym.export.yml

File

console/translations/en/searchapi.synonym.export.yml
View source 
  1. description: 'Export search synonyms to a specific format.'

  2. options:

  3.   plugin:

  4.     description: 'Machine name of the export plugin. E.g. solr.'

  5.   langcode:

  6.     description: 'Language being exported. Use the language code. E.g. en or da.'

  7.   type:

  8.     description: 'Synonym type. Allowed values: synonym = Synomyms, spelling_error = Spelling errors, all = All types (synonyms and spelling errors). If option not defined will all types be exported.'

  9.   filter:

  10.     description: 'Export filter. Allowed values: nospace = Skip all words containing a space, onlyspace = Skip all words without a space.'

  11.   incremental:

  12.     description: 'Incremental export - use Unix timestamp. Only export synonyms changed after the provided timestamp.'

  13.   file:

  14.     description: 'File name used when saving the exported file. Include extension and not folder name!'

  15. arguments: {}

  16. messages:

  17.   start: 'Starting synonym export....'

  18.   success: 'Synonyms export and saved in the following file:'

  19.   invalidplugin: '--plugin is not valid. Please, use an existing plugin machine name.'

  20.   invalidlangcode: '--langcode is not valid. Please, use an existing language code.'

  21.   invalidtype: '--type option is not valid. The only allowed values are "synonym", "spelling_error", "all".'

  22.   invalidfilter: '--filter option is not valid. The only allowed values are "nospace", "onlyspace", "all".'

  23.