tirith icon indicating copy to clipboard operation
tirith copied to clipboard

Improve code structure and metadata for providers

Open samriddhi99 opened this issue 1 year ago • 2 comments

The current implementation of the providers has several areas that need improvement to enhance clarity, maintainability, and robustness.

  • [ ] There is no clear documentation or structure indicating which arguments are required for each operation type (input_type). This can lead to confusion and errors in usage.
  • [ ] There is no straightforward way to list all supported input_type values programmatically. This could be solved by defining a constant or enumeration for operation types.
  • [ ] Functions aren't modular/reusable.

samriddhi99 avatar Jul 03 '24 17:07 samriddhi99

TODO:

  • Add possible approaches and designs to introduce metadata to the Tirith providers and schema
    • Also consider that Tirith providers will not be in the Tirith core repository, it will be separated, and users can create their own custom providers, so that providers and core should be decoupled

refeed avatar Jul 10 '24 07:07 refeed

This is related a little bit to https://github.com/StackGuardian/tirith/issues/154

refeed avatar Aug 02 '24 09:08 refeed