Skip to content

Add ability to edit custom config parameters, both for global and bot configs #1698

Open
Open
Add ability to edit custom config parameters, both for global and bot configs#1698
Labels
✨ EnhancementIssues marked with this label indicate further enhancements to the program, such as new features.👍 PR-okIssues marked with this label are good candidates for being accepted in a pull request.🙏 WishlistIssues marked with this label are wishlisted. We'd like to make them happen but they're not crucial.

Description

@Rudokhvist
Rudokhvist
opened on Oct 14, 2024

Checklist

  • I read and understood ASF-ui's Contributing Guidelines
  • I also read FAQ
  • My idea doesn't duplicate existing ASF-ui functionality described on the wiki
  • I believe that my idea falls into ASF-ui's scope and should be offered as part of ASF-ui built-in functionality
  • This is not ASF suggestion

Enhancement purpose

Add ability to edit custom properties in configuration files, that are parsed by third-party plugins.

Solution

I believe it should be a multi-line text area with non-parsed json of unsupported parameters. Upon saving would be nice to check if it's still valid json, if possible, and show error without saving otherwise.

Why currently available solutions are not sufficient?

Currently editing those parameters only possible by directly editing files on disk. For VPS-hosted ASF it will be more convenient to have ability to edit them via ASF-ui

Can you help us with this enhancement idea?

Somehow, I can test and offer feedback, but can't code

Additional info

Theoretically, we can agree on some "well-known" endpoint where plugins should report schema for supported parameters. But it looks a bit hard to implement, so I believe just a field with json should do.

Activity

  1. Rudokhvist
    added
    ✨ EnhancementIssues marked with this label indicate further enhancements to the program, such as new features.
    🧐 EvaluationIssues marked with this label are currently being evaluated if they're going to be considered.
    on Oct 14, 2024
  2. MrBurrBurr
    added
    👍 PR-okIssues marked with this label are good candidates for being accepted in a pull request.
    and removed
    🧐 EvaluationIssues marked with this label are currently being evaluated if they're going to be considered.
    on Oct 14, 2024

  3. JustArchi commented on Oct 14, 2024

    @JustArchi
    JustArchi
    on Oct 14, 2024
    Member

    The API already returns all the defined properties, and of course saves them back, so it seems there is no ASF block here:

    obraz

    How I see it:

    • Check swagger spec to discover all recognized properties. Those should be presented normally because swagger defines type for each property, so you can present them nicely in the UI.
    • All extra unknown properties should be rendered as some kind of additional view, like @Rudokhvist suggested above. We can't do much with them because we don't know their type (sometimes you can guess from true or false to be a boolean, but good luck guessing from null).
    • ASF-ui can simply append extra properties from that additional view to final json sent to ASF, so everything will be saved.

    Wishlist:

    • Plugins can expose config properties through swagger. It's a matter of agreeing on some general path and making ASF-ui parse the types from there. I did it with STD plugin for example.

  4. Aareksio commented on Oct 14, 2024

    @Aareksio
    Aareksio
    on Oct 14, 2024
    Member

    I smell #1022

  5. MrBurrBurr
    changed the title [-]Add ability to edit custom config parameters, both for global and bot configs.[/-] [+]Add ability to edit custom config parameters, both for global and bot configs[/+] on Dec 25, 2024
  6. MrBurrBurr
    added
    🙏 WishlistIssues marked with this label are wishlisted. We'd like to make them happen but they're not crucial.
    on Dec 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ✨ EnhancementIssues marked with this label indicate further enhancements to the program, such as new features.👍 PR-okIssues marked with this label are good candidates for being accepted in a pull request.🙏 WishlistIssues marked with this label are wishlisted. We'd like to make them happen but they're not crucial.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions