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

[Feature] Doc parameters order respect action order #546

Open
2 tasks done
z15alall opened this issue Feb 2, 2024 · 0 comments
Open
2 tasks done

[Feature] Doc parameters order respect action order #546

z15alall opened this issue Feb 2, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@z15alall
Copy link

z15alall commented Feb 2, 2024

Is this feature missing in the latest version?

  • I'm using the latest release

Is your feature request related to a problem? Please describe.

Currently Inputs are listed in alphanumeric order and don't respect action order.

Describe the solution you'd like?

For our point of view it's better to have requiered parameters on the top of documentation and in a specific order. For example It's more easy for our customer to see what is required like that, instead of searching all required parameters. Our actions parameters are contruct in like that.

I think it will be great to have an option to perserve order parameters in actions to the generated doc instead of order by alphanumeric value.

name: "myAction"
description: "myAction"
inputs:
  b_inputs:
    description: "Inputs B required"
    required: true

  c_inputs:
    description: "Inputs C required"
    required: true

  a_inputs:
    description: "Inputs A non required"
    required: false

with actual version docs will be :
a_inputs | not required
b_inputs | required
c_inputs | required

with this new feature, order will be preserve :
b_inputs | required
c_inputs | required
a_inputs | not required

Describe alternatives you've considered?

Need to change manually this order of parameters to have required parameter on the top of the doc

Anything else?

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@z15alall z15alall added the enhancement New feature or request label Feb 2, 2024
@z15alall z15alall changed the title [Feature] REQUIRED parameters at the top of the generated docs [Feature] Doc parameters order respect action order Feb 2, 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
Projects
None yet
Development

No branches or pull requests

1 participant