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

Plan(s) listing in the result structure #41

Open
jan-dolejsi opened this issue Jun 1, 2022 · 3 comments
Open

Plan(s) listing in the result structure #41

jan-dolejsi opened this issue Jun 1, 2022 · 3 comments

Comments

@jan-dolejsi
Copy link

I do not see a reason for exposing internal implementation details in the returned structure. If the planner finds multiple plans, they should be returned in a uniform structure such as

{
  "result": {
      "plans": [
       ]
  }
}

Currently I see result.output.plan as well as result.output.sas_plan or result.output.sas_plan.1. We are bleeding implementation details through the interface. Or I at least cannot see any added value here.

I am not discussing here whether the content of the plans array should be strings (as today) or some rich structure. But it should be an array capturing plans in order of discovery.

@haz
Copy link
Contributor

haz commented Jun 1, 2022

This is entirely up to the package author's discretion. It does bleed implementation details, but that's potentially extremely useful. E.g., maybe the FD deploy wants to return the output.sas (intermediate) file as well for other purposes.

@jan-dolejsi
Copy link
Author

That is legitimate. But in that case there should be a clear indication of which of the entries are plans and which are something else. We are on the receiving side of this, so it cannot be completely up to the author's discretion.

@haz
Copy link
Contributor

haz commented Jun 3, 2022

Completely agree, yep! "Extra stuff" can be just that, and a standard "this is a plan" can be used to parse things nicely as discussed in #36

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants