Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to comment each Operation to explain its usage #229

Open
AFract opened this issue May 22, 2024 · 1 comment
Open

Ability to comment each Operation to explain its usage #229

AFract opened this issue May 22, 2024 · 1 comment
Labels
enhancement New feature or request status:planned We plan to work on this

Comments

@AFract
Copy link

AFract commented May 22, 2024

Hello,

Here's a request for a possible improvement.

For complex services involving hundred of operations declined in several cases, having a clear name on each operation isn't always enough to quickly find and understand each of them.

Could it be possible in a future release to add something for better management of operations description ?

For example

  • On a directory, a list of all its operations and for each of them some kind of "Comment / Description" free-text field
  • A "Comment" option on each operation, or collection (etc)
  • The ability to have a markdown file in each directory, viewable/editable directly in Kreya

Thank you !

@AFract AFract added the enhancement New feature or request label May 22, 2024
@AFract AFract changed the title Comments on each Operation Ability to comment each Operation to explain its usage May 22, 2024
@CommonGuy
Copy link
Contributor

Interesting idea! We will think about this, since as you mentioned there are lots of ways to implement this...

@CommonGuy CommonGuy added the status:planned We plan to work on this label May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request status:planned We plan to work on this
Projects
None yet
Development

No branches or pull requests

2 participants