Module crowdin_api.api_resources.dictionaries.resource

Classes

class DictionariesResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Dictionaries.

Dictionaries allow you to create a storage of words that should be skipped by the spell checker.

Use API to get the list of organization dictionaries and to edit a specific dictionary.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Dictionaries

Ancestors

• BaseResource

Methods

def edit_dictionary(self, languageId: str, data: Iterable[DictionaryPatchRequest], projectId: Optional[int] = None)

Edit Dictionary.

:param data: JSON Patch operations ("add"/"remove") on "/words/{index}" paths, e.g. {"op": "add", "path": "/words/-", "value": "word"} or {"op": "remove", "path": "/words/0"}. To remove several words in one request, specify the word indexes in reverse order.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.dictionaries.patch

def list_dictionaries(self, projectId: Optional[int] = None, languageIds: Optional[Iterable[str]] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Dictionaries.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.dictionaries.getMany