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

Create WorkflowConfig object to re-use across API calls #413

Open
PatStLouis opened this issue Aug 20, 2024 · 2 comments
Open

Create WorkflowConfig object to re-use across API calls #413

PatStLouis opened this issue Aug 20, 2024 · 2 comments
Assignees
Labels
ready for PR Issue ready to be resolved via a Pull Request

Comments

@PatStLouis
Copy link
Collaborator

Following #409, we want to create a workflowConfig object to re-use across calls

@PatStLouis PatStLouis self-assigned this Aug 20, 2024
@msporny msporny added the ready for PR Issue ready to be resolved via a Pull Request label Aug 20, 2024
@PatStLouis
Copy link
Collaborator Author

Point of discussion, the steps property.

The model currently looks like this:

steps [object]
    One or more steps required to complete an exchange on the workflow. The steps object MUST be an object of the following form:

    stepName [object]
        The name of the step. The stepName object MUST be an object of the following form:

        step [object]
            Object containing information about a workflow step. The step object MUST be either an object of the following form: 

While I understand what it's meant to represent, the way it's modeled is confusing such as the description of the stepName being the name of the step while being an object.

@msporny
Copy link
Contributor

msporny commented Sep 10, 2024

The group discussed this on the 2024-09-10 call:

@PatStLouis noted his comment above as a concern. @dlongley noted that "steps" is an object where they keys are the name of the steps. Lots of discussion, but end result was to modify the text and possibly the code to ensure that the output is easier to read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for PR Issue ready to be resolved via a Pull Request
Projects
None yet
Development

No branches or pull requests

2 participants