API routes

The API is being designed and developed, with priority on current needs. Specifications are available in redoc (which is better formatted visually) and swagger (which allows you to try the API via the interface).

Here is a list of the current routes (last update: 08.09.2022). All routes are available with POST, while some of them also have GET or batch POST alternatives (ref). Routes that are in development are available to try but not yet thoroughly tested and subject to changes, while those in design can be browsed for (provisional) specifications but are not yet implemented. The routes that are not read-only have restricted access.

Route	Status	Read-only	Description
/search/lexical-unit/	development	yes	search for lexical units
/retrieve/lexical-unit-lexemes/:lexical_unit_id/	design	yes	get the lexical unit's component lexemes
/get-or-create/lexical-unit/	design	no	get or create a lexical unit based on properties and components
/search/lexeme/	development	yes	search for lexemes
/retrieve/lexeme/:lexeme_id/	development	yes	get a lexeme
/get-or-create/lexeme/	development	no	get or create a lexeme based on defining properties
/search/form/	development	yes	search for word forms by string
/get-or-create/resource/	development	yes	get or create a new dictionary or other resource
/search/resource/	design	no	search or list resources available
/attach/lexical-unit/:lexical_unit_id/	development	yes	attach a lexical unit to a resource
/detach/lexical-unit/:lexical_unit_id/	development	no	detach a lexical unit from a resource
/process/string-to-tokens/	development	yes	parse a Slovene string to get a list of tokens