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

Allow variables to be embedded in the desc section #672

Open
k2tzumi opened this issue Nov 3, 2023 · 2 comments
Open

Allow variables to be embedded in the desc section #672

k2tzumi opened this issue Nov 3, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@k2tzumi
Copy link
Collaborator

k2tzumi commented Nov 3, 2023

vars:
  username: "foo"
steps:
- desc: "Retrieve a list of {{vars.username}} articles"
  req:
    /api/articles?username={{ vars.username }}&count=96&order=latest:
      get:
        body:
          application/json: null
@k1LoW
Copy link
Owner

k1LoW commented Nov 5, 2023

LGTM!

This feature may be somewhat of a bottleneck when trying to statically generate documentation without running a runbook.
However, we believe that the decision to use this feature or to generate documentation should be left to the user.

@k2tzumi
Copy link
Collaborator Author

k2tzumi commented Nov 5, 2023

I see. So this is a case of static analysis to get only the description.

@k1LoW k1LoW added the enhancement New feature or request label Dec 2, 2023
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

2 participants