search

w3c-ccg / vc-api

A specification for an HTTP API used to issue and verify Verifiable Credentials.
https://w3c-ccg.github.io/vc-api
Other
124 stars 47 forks source link

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

Open PatStLouis opened 3 months ago

PatStLouis commented 3 months ago

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

PatStLouis commented 2 months ago

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 commented 2 months ago

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.