F B via FreeIPA-users wrote: > Background: > I have a working FreeIPA setup that incorporates NFSv4 shares from a NAS > utilising Kerberos. Part of this setup was creating an Object Class with two > attributes. In order to streamline the process of configuring the attributes > during user creation, I've created a plugin by scraping together information > from here, the FreeIPA website, GitHub, and some other sources. The plugin > works for setting the two attribute values during user creation, and during > modification in the web user interface. > > Question: > Apart from combing through the FreeIPA code, where can I find more detailed > information for improving my plugin? Something akin to an API reference? Or > documentation that describes the objects and methods (including parameters, > and return values)? > For example, where can I find a comprehensive list of facet sections? > Or where can I find a full spec of the field for pushing into the section? > Where can I find detailed information for the Python side of things as well?
The JSON API is documented at https://freeipa.readthedocs.io/en/latest/api/index.html The python API is more or less self-documented in ipalib. The fundamentals anyway. AFAIK there is no standalone documentation for the WebUI. > I noticed this message in the httpd error_log: ipaserver.plugins.my_plugin is > not a valid plugin module > However, the plugin works. My plugin isn't the only one generating this > error. Some of the ones that shipped with FreeIPA also generate this message. > [baseldap, hbac, otp, rabase] hbac and otp are there for help purposes: they provide a doc string. baseldap and rabase and base plugins and don't provided API functionality. A plugin needs to have register = Registry() in order to be considered an API plugin. > Is there a reason for this? > > I would be grateful if someone can point me in the correct direction. I'm not > sure if this ask is outside the scope of what this community provides, bear > with me if it is. > The freeipa-devel list is probably a more appropriate venue but this is fine. -- _______________________________________________ FreeIPA-users mailing list -- [email protected] To unsubscribe send an email to [email protected] Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedorahosted.org/archives/list/[email protected] Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue
