[iLLiCiTiT]

Changelog Description

Added methods for AYON server 1.16.8 REST endpoints that had no wrapper in the python api.

Additional info

Every route in server 1.16.8 was compared with the endpoints the api calls. Payloads and query params were checked against the server request models.

New helper classes (added to ServerAPI and automated_api.py): UsersAPI, ServicesAPI, SystemAPI, ReviewablesAPI.

• Users: create, update, delete and rename user, password, user access groups, sessions, api keys, permissions. Access groups CRUD and set_projects_access. Teams and team members. Project users.
• Addon settings: set_addon_settings, get_addon_overrides, modify_addon_overrides, delete_addon_overrides, get_addon_raw_overrides, set_addon_raw_overrides (call the studio or project specific method, e.g. set_addon_studio_settings or set_addon_project_settings, based on project_name), set_addon_site_settings, migrate_addon_settings, migrate_settings_by_bundle. get_addon_settings_schema takes optional variant and site_id.
• Projects: anatomy presets (save, rename, delete, set and unset primary), anatomy schema, get and set project anatomy, rename_project, project stats and tags, project bundle (get, set, unset), set_project_root_overrides, get_project_entity_uris, resolve_uris, get_project_file_info.
• Folders: search_folders, get_entity_groups.
• Services and system: services (list, spawn, update, delete), hosts, sites (list, delete), restart required (get, set), server config schema, update_server_config (PATCH), enums.
• Events: delete_events through eventops. An empty filter deletes all events on the server side.
• Review and tasks: reviewables for entities (list, sort, update label), assign_users_to_task, entity list materialize and items order, entity and project thumbnail upload, get_project_thumbnail.

_api.py and __init__.py were regenerated with automated_api.py. The _api.py diff only adds lines; plain git diff shows it as moved because of the diff algorithm.

Not added on purpose: endpoints used only by the web UI (onboarding, Ynput Cloud connect, metrics, csv import and export, avatars, password reset, views, frontend preferences, market) and deprecated routes.

Server version requirements

Endpoints and arguments were compared between server 1.14.5 (the last 1.14.x) and 1.16.8. The ones added later raise UnsupportedServerVersion on older servers:

• 1.15.0: rename_project, get_project_thumbnail, set_project_thumbnail, set_project_thumbnail_from_stream
• 1.15.4: search argument of search_folders
• 1.15.9: update_server_config, set_entity_list_items_order
• 1.16.4: get_enums, get_reviewables, latest and latest_done of the entity reviewables getters
• 1.16.7: error argument of update_service
• 1.16.8: migrate_addon_settings

On servers older than 1.15.0, rename_user uses the deprecated PATCH endpoint instead of failing. The registryAuth service config key (1.16.7) is only documented, because older servers ignore unknown config keys.

Testing notes:

New tests run against a real AYON server, like the other server tests (AYON_SERVER_URL and AYON_API_KEY of an admin user). They create only temporary users, access groups, projects, sites and events, and remove them afterwards. Studio-level addon settings are written to a temporary settings variant.

• tests/test_users_api.py, tests/test_addon_settings_api.py, tests/test_projects_api.py, tests/test_system_api.py, tests/test_review_tasks_lists_api.py
• tests/test_server_version_validation.py checks the version validation and needs no server.

1. Set AYON_SERVER_URL and AYON_API_KEY.
2. Run pytest tests/test_users_api.py tests/test_addon_settings_api.py tests/test_projects_api.py tests/test_system_api.py tests/test_review_tasks_lists_api.py tests/test_server_version_validation.py.

🤖 Generated with Claude Code

[BigRoy]

@tadeas-hejnic can you test this - and review this if the code and API makes sense to you?

@MustafaJafar any question on some of these from docs standpoint?

[MustafaJafar]

@MustafaJafar any question on some of these from docs standpoint?

Not at all, thank you for the heads up. fyi, the python api docs are simply generated and deployed on release.

Also, I'm considering visiting the docs generation setup for this repo to make it on par with the other docs (either switch to mk docs, or simply keep the current while updating the theme).

[iLLiCiTiT]

Also, I'm considering visiting the docs generation setup for this repo to make it on par with the other docs (either switch to mk docs, or simply keep the current while updating the theme).

I did this #367 because poetry was broken in some of the newer PRs.

[tadeas-hejnic]

This test is failing on my side, because raw = {}, so the assert can't be passed.

But it's probably backend issue, because extract_overrides() can't go deeper in recursion for explicit_pins - https://github.com/ynput/ayon-backend/blob/develop/ayon_server/settings/overrides.py#L212-L231

There should be probably added something like:

def has_pin_below(path):
    return any(
        pin[:len(path)] == path
        for pin in explicit_pins
    )

to the condition before the recursive call.

@iLLiCiTiT @martastain

[tadeas-hejnic]

Tested on my side with this change and at least this test has passed and looks like it didn't break anything.

[iLLiCiTiT]

I will probably remove the test. It is kinda pointless. This does test if pinning works but without a known addon you can't test it reliable.

[iLLiCiTiT]

Or maybe just fix it in server? Made a PR ynput/ayon-backend#1208 with that we can keep the test.

[iLLiCiTiT]

I'd say bug on server should not block this PR. If yes, then I'll remove the test...