Skip to content

docs: add informative reference workflow step processing algorithm#626

Draft
PatStLouis wants to merge 3 commits into
mainfrom
workflow-processing-algorithm-596
Draft

docs: add informative reference workflow step processing algorithm#626
PatStLouis wants to merge 3 commits into
mainfrom
workflow-processing-algorithm-596

Conversation

@PatStLouis

@PatStLouis PatStLouis commented Apr 14, 2026

Copy link
Copy Markdown
Collaborator

Add an informative subsection under Workflows and Exchanges with the exchange processing loop and hooks described in GitHub discussion, plus editorial fixes (grammar, parenthesis) from the issue text.

Closes #596.


💥 Error: 500 Internal Server Error 💥

PR Preview failed to build. (Last tried on Apr 28, 2026, 7:33 PM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

🚨 Spec Generator - Spec Generator is the web service used to build bikeshed/ReSpec specs

🔗 Related URL

Error output:

EISDIR: illegal operation on a directory, open 'uploads/8ER9gU/'

This seems to be an issue with the Spec Generator service. PR Preview doesn't manage this service and so has no control over it. If you've identified an issue with it, you can report the issue to the maintainers of Spec Generator directly. Please be courteous. Thank you!

If you don't have enough information above to solve the error by yourself or if the issue doesn't seem related to Spec Generator, you can file an issue with PR Preview.

Add an informative subsection under Workflows and Exchanges with the
exchange processing loop and hooks described in GitHub discussion, plus
editorial fixes (grammar, parenthesis) from the issue text.

Closes #596.

Signed-off-by: Patrick St-Louis <patrick.st-louis@opsecid.ca>
Made-with: Cursor
Spec body should not point readers at issue threads for attribution.

Signed-off-by: Patrick St-Louis <patrick.st-louis@opsecid.ca>
Made-with: Cursor
@PatStLouis
PatStLouis marked this pull request as draft April 14, 2026 19:58
@PatStLouis
PatStLouis marked this pull request as draft April 14, 2026 19:58
Comment thread index.html
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
@iherman

iherman commented May 27, 2026

Copy link
Copy Markdown
Member

This was discussed during the vcwg meeting on 26 May 2026.

View the transcript

docs: add informative reference workflow step processing algorithm by PatStLouis · Pull Request #626 · w3c/vcalm · GitHub

Patrick_St-Louis: So I will need to review this and make another proposal. yes, Manu.

Manu_Sporny: Yeah, plus one to that. just when you do the algorithmic part down there at the bottom, try to use the O or OLI syntax, it'll do auto numbering for the algorithm and all that kind of stuff. you could probably take this text and run it through an LLM and it'll generate the right format. which I think we do have some other algorithms in the spec.

Manu_Sporny: So you could follow the ones in the data integrity spec. those kind of have the right shape as well.

Patrick_St-Louis: Yeah, that sounds good.

Patrick_St-Louis: So, I will take this on myself and review this. That's why it's still in draft. and that's pretty much going to do it for us. I know Manuel, I think you came in on the call a bit later. I don't know if you followed our discussion about the example for the request bodies and response. were you here when we discussed that?

Patrick_St-Louis: Yes. Yeah.

Manu_Sporny: Yeah, part of it I think the plan was to just simplify it and…

Manu_Sporny: just try to just use ID context and type or something like that.

Patrick_St-Louis: Kind of a minimal and…

Manu_Sporny: Yeah. Yeah,…

Patrick_St-Louis: allow people to extend other things.

Patrick_St-Louis: And to be clear that we explained that this is to allow different data model version which have some minor changes.

Manu_Sporny: with the only addition, this is just a technical thing. the respect OAS plugin could be expanded to kind of describe hey, what we're really talking about here is an object from the VC data model spec. look over there if you want to understand more about what this object looks like. we can add something to that to make it plus one to removing all the extra crust and… Manu Sporny:

Patrick_St-Louis: Yeah. Yeah.

Manu_Sporny: then putting in a simple statement that just points people to another specification. I think that might be a good thing to do. Yeah.

Patrick_St-Louis: Even look at the description here. because I think the credential object right the root level of the property are not going to change. And this was by purpose, right? I remember when we were discussing do we want to return the raw c this credential key, So all of these are kind of protected with this root level property. This seems like a good place to include this or I've even seen which one? Yeah, there's some notes that are added here.

Manu_Sporny: Yeah.


@TallTed

TallTed commented Jun 2, 2026

Copy link
Copy Markdown
Member

Might be worth pushing a commit, to see whether PR-Preview is working again, so that the output HTML rendering can be reviewed...

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.

Consider defining normative/non-normative workflow processing algorithm

3 participants