Rework OCM-API diagrams, sync OpenAPI to draft#390
Merged
Conversation
Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
glpatcern
requested changes
Jul 22, 2026
glpatcern
left a comment
Member
There was a problem hiding this comment.
This is all very good, in particular the diagrams are excellent!
As discussed, some relatively minor changes on the yaml
Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>
glpatcern
self-requested a review
July 23, 2026 08:04
glpatcern
approved these changes
Jul 23, 2026
glpatcern
left a comment
Member
There was a problem hiding this comment.
Looks good! In particular the diagrams are now much more descriptive, I think some adjustments can still be done but it's a very good progress already.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This makes the OCM-API spec easier to navigate and to implement from.
Three things landed here, all in service of the same goal: help implementers and users find the normative home for each concept.
orthogonal planes and the per-endpoint signing rules have a single pointer
table.
diagrams/folder: 8 numbered diagrams plus aREADME.md,with a unified palette and a style contract.
spec.yamlaligned to the current I-D draft.The part that made me stop and think for some time is that the spec described the four planes (discovery, share, peer interaction, enforcement) only implicitly, and the diagrams did not share a vocabulary or palette.
An implementer reading
IETF-OCM.mdhad no single place to land.I think this is the right direction: keep the draft normative, add informative pointers and diagrams, and make the OpenAPI match the draft.
No new normative rules are introduced by the diagrams or the indexes