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

Action doc #93

Closed
wants to merge 5 commits into from
Closed

Action doc #93

wants to merge 5 commits into from

Conversation

skothari-tibco
Copy link
Contributor

No description provided.

@abramvandergeest
Copy link
Contributor

Hi Samip,
Generally, I think we need a lot more detail on how individual portions of the spec was translated into flogo/go. If you are in the office tomorrow maybe we can chat about it a bit. Some points that I think need to be added:

  • We need to know how the data structures are supported within the implementation (i.e. image is a []byte structure, list is a []interface{}, map is map[string]interface{}, etc.)

  • We need to expand on how mappers work in converting data from input into the specification (other than giving a random link to largely empty go file)

  • mentioned how the metadata is treated/stored/ignored

  • mention how comments are handled in the processing of the json

  • define an operation in words, something more than 'defined in the CML spec.' How did you define it? is it a struc? is it a map? how did you implement it? Maybe start with "I modified a flogo activity to ..." Then define an activity/operation. Then say what you modifications were.

  • Explain how object names and references to structure components (i.e. $n['col1']) are handled (that some parts of thee go's references are used because they overlap)

  • Discuss that the operation.json is used as a descriptor.json for the operations for future connections to GUIs/builders/etc, but that it is not used by the go code

-discuss operations that break the normal - apply, applyToInputs, runCML in how they were treated differently

My suggestion would be to write a couple paragraphs for each section within the spec and interlace it with what you currently have.

@abramvandergeest
Copy link
Contributor

Closing this because you addressed in (I think anyways) PR #139

@skothari-tibco skothari-tibco deleted the action_doc branch May 13, 2020 13:22
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

Successfully merging this pull request may close these issues.

2 participants