Using BaseServerAddon to modify api endpoints

tanh · 5 September 2024 05:34

Hello,

I just wonder if the class BaseServerAddon would be some thing that can override existing api expoint such as /api/users/[USERNAME]/avatar.

There’s some code here that uses BaseServerAddon.add_endpoint but I’m not 100% sure how it works and whether it can override existing api calls.

github.com

scottmcdonnell/ayon-kitsu/blob/b4113dc99cddd37b278e68e2881af930b5842c78/server/init.py

from typing import Type

from nxtools import logging

from ayon_server.addons import BaseServerAddon
from ayon_server.api.dependencies import CurrentUser
from ayon_server.api.responses import EmptyResponse
from ayon_server.exceptions import ForbiddenException, InvalidSettingsException
from ayon_server.secrets import Secrets

from .kitsu import Kitsu, KitsuMock
from .kitsu.init_pairing import InitPairingRequest, init_pairing, sync_request
from .kitsu.pairing_list import PairingItemModel, get_pairing_list
from .kitsu.push import (
    PushEntitiesRequestModel,
    RemoveEntitiesRequestModel,
    push_entities,
    remove_entities,
)
from .settings import DEFAULT_VALUES, KitsuSettings

This file has been truncated. show original

What is the best way to override behaviours defined in ayon-backend (such as ayon-backend\api\users\users.py) using addons?

Regards,
Tu

BigRoy · 5 September 2024 11:12

First off, why would you want to override it?

tanh · 5 September 2024 23:42

Hullo, I was investigating on if there is a way to use plugin to integrate LDAP to AYON.

Yul · 6 September 2024 08:51

Hello tanh

There is already an Addon for that, as described here :