Module: Weblate

Defined in:
lib/weblate/version.rb,
lib/weblate.rb,
lib/weblate/api_error.rb,
lib/weblate/api_client.rb,
lib/weblate/models/role.rb,
lib/weblate/models/unit.rb,
lib/weblate/models/addon.rb,
lib/weblate/models/group.rb,
lib/weblate/api/roles_api.rb,
lib/weblate/api/tasks_api.rb,
lib/weblate/api/units_api.rb,
lib/weblate/api/users_api.rb,
lib/weblate/configuration.rb,
lib/weblate/models/change.rb,
lib/weblate/models/memory.rb,
lib/weblate/api/addons_api.rb,
lib/weblate/api/groups_api.rb,
lib/weblate/api/memory_api.rb,
lib/weblate/api/search_api.rb,
lib/weblate/models/metrics.rb,
lib/weblate/models/project.rb,
lib/weblate/api/changes_api.rb,
lib/weblate/api/metrics_api.rb,
lib/weblate/models/category.rb,
lib/weblate/models/language.rb,
lib/weblate/models/vcs_enum.rb,
lib/weblate/api/projects_api.rb,
lib/weblate/models/component.rb,
lib/weblate/api/languages_api.rb,
lib/weblate/models/basic_user.rb,
lib/weblate/models/blank_enum.rb,
lib/weblate/models/color_enum.rb,
lib/weblate/models/fuzzy_enum.rb,
lib/weblate/models/scope_enum.rb,
lib/weblate/models/screenshot.rb,
lib/weblate/models/state_enum.rb,
lib/weblate/models/unit_write.rb,
lib/weblate/api/categories_api.rb,
lib/weblate/api/components_api.rb,
lib/weblate/models/action_enum.rb,
lib/weblate/models/method_enum.rb,
lib/weblate/models/source_enum.rb,
lib/weblate/models/translation.rb,
lib/weblate/models/unit_labels.rb,
lib/weblate/api/screenshots_api.rb,
lib/weblate/models/license_enum.rb,
lib/weblate/models/lock_request.rb,
lib/weblate/models/notification.rb,
lib/weblate/models/patched_role.rb,
lib/weblate/models/repo_request.rb,
lib/weblate/api/translations_api.rb,
lib/weblate/models/new_lang_enum.rb,
lib/weblate/models/patched_addon.rb,
lib/weblate/models/patched_group.rb,
lib/weblate/models/priority_enum.rb,
lib/weblate/models/component_list.rb,
lib/weblate/models/conflicts_enum.rb,
lib/weblate/models/direction_enum.rb,
lib/weblate/models/frequency_enum.rb,
lib/weblate/models/operation_enum.rb,
lib/weblate/models/patched_memory.rb,
lib/weblate/models/text_direction.rb,
lib/weblate/models/upload_request.rb,
lib/weblate/models/language_plural.rb,
lib/weblate/models/patched_project.rb,
lib/weblate/models/screenshot_file.rb,
lib/weblate/api/component_lists_api.rb,
lib/weblate/models/file_format_enum.rb,
lib/weblate/models/merge_style_enum.rb,
lib/weblate/models/patched_category.rb,
lib/weblate/models/patched_language.rb,
lib/weblate/models/unit_flat_labels.rb,
lib/weblate/models/notification_enum.rb,
lib/weblate/models/patched_component.rb,
lib/weblate/models/patched_basic_user.rb,
lib/weblate/models/patched_screenshot.rb,
lib/weblate/models/patched_unit_write.rb,
lib/weblate/models/auto_component_list.rb,
lib/weblate/models/paginated_role_list.rb,
lib/weblate/models/paginated_unit_list.rb,
lib/weblate/models/paginated_addon_list.rb,
lib/weblate/models/paginated_group_list.rb,
lib/weblate/models/patched_notification.rb,
lib/weblate/models/upload_request_fuzzy.rb,
lib/weblate/models/paginated_change_list.rb,
lib/weblate/models/paginated_memory_list.rb,
lib/weblate/models/paginated_project_list.rb,
lib/weblate/models/patched_component_list.rb,
lib/weblate/models/project_selection_enum.rb,
lib/weblate/models/language_selection_enum.rb,
lib/weblate/models/paginated_category_list.rb,
lib/weblate/models/paginated_language_list.rb,
lib/weblate/models/language_code_style_enum.rb,
lib/weblate/models/paginated_component_list.rb,
lib/weblate/models/upload_request_conflicts.rb,
lib/weblate/models/paginated_basic_user_list.rb,
lib/weblate/models/paginated_screenshot_list.rb,
lib/weblate/models/paginated_translation_list.rb,
lib/weblate/models/paginated_notification_list.rb,
lib/weblate/models/component_language_code_style.rb,
lib/weblate/models/paginated_component_list_list.rb

Overview

#Weblate’s REST API

# The API is accessible on the “/api/“ URL and it is based on [Django REST framework](www.django-rest-framework.org/). The OpenAPI specification is available as feature preview, feedback welcome!

The version of the OpenAPI document:

Generated by: openapi-generator.tech Generator version: 7.9.0

Defined Under Namespace

Modules: ComponentLanguageCodeStyle, TextDirection, UploadRequestConflicts, UploadRequestFuzzy Classes: ActionEnum, Addon, AddonsApi, ApiClient, ApiError, AutoComponentList, BasicUser, BlankEnum, CategoriesApi, Category, Change, ChangesApi, ColorEnum, Component, ComponentList, ComponentListsApi, ComponentsApi, Configuration, ConflictsEnum, DirectionEnum, FileFormatEnum, FrequencyEnum, FuzzyEnum, Group, GroupsApi, Language, LanguageCodeStyleEnum, LanguagePlural, LanguageSelectionEnum, LanguagesApi, LicenseEnum, LockRequest, Memory, MemoryApi, MergeStyleEnum, MethodEnum, Metrics, MetricsApi, NewLangEnum, Notification, NotificationEnum, OperationEnum, PaginatedAddonList, PaginatedBasicUserList, PaginatedCategoryList, PaginatedChangeList, PaginatedComponentList, PaginatedComponentListList, PaginatedGroupList, PaginatedLanguageList, PaginatedMemoryList, PaginatedNotificationList, PaginatedProjectList, PaginatedRoleList, PaginatedScreenshotList, PaginatedTranslationList, PaginatedUnitList, PatchedAddon, PatchedBasicUser, PatchedCategory, PatchedComponent, PatchedComponentList, PatchedGroup, PatchedLanguage, PatchedMemory, PatchedNotification, PatchedProject, PatchedRole, PatchedScreenshot, PatchedUnitWrite, PriorityEnum, Project, ProjectSelectionEnum, ProjectsApi, RepoRequest, Role, RolesApi, ScopeEnum, Screenshot, ScreenshotFile, ScreenshotsApi, SearchApi, SourceEnum, StateEnum, TasksApi, Translation, TranslationsApi, Unit, UnitFlatLabels, UnitLabels, UnitWrite, UnitsApi, UploadRequest, UsersApi, VcsEnum

Constant Summary collapse

VERSION =
'0.1.1'

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block.

Weblate.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



127
128
129
130
131
132
133
# File 'lib/weblate.rb', line 127

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end