Skip to content

Rework OCM-API diagrams, sync OpenAPI to draft#390

Merged
MahdiBaghbani merged 7 commits into
developfrom
spec-openapi-diagrams-nav
Jul 23, 2026
Merged

Rework OCM-API diagrams, sync OpenAPI to draft#390
MahdiBaghbani merged 7 commits into
developfrom
spec-openapi-diagrams-nav

Conversation

@MahdiBaghbani

@MahdiBaghbani MahdiBaghbani commented Jul 22, 2026

Copy link
Copy Markdown
Member

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.

  • A navigation index and a signing direction index in the I-D, so the four
    orthogonal planes and the per-endpoint signing rules have a single pointer
    table.
  • A reworked diagrams/ folder: 8 numbered diagrams plus a README.md,
    with a unified palette and a style contract.
  • spec.yaml aligned 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.md had 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

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>
@MahdiBaghbani MahdiBaghbani self-assigned this Jul 22, 2026

@glpatcern glpatcern left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all very good, in particular the diagrams are excellent!
As discussed, some relatively minor changes on the yaml

Comment thread IETF-OCM.md
Comment thread spec.yaml Outdated
Comment thread spec.yaml Outdated
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
glpatcern self-requested a review July 23, 2026 08:04

@glpatcern glpatcern left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@MahdiBaghbani
MahdiBaghbani merged commit a5b5da6 into develop Jul 23, 2026
4 checks passed
@MahdiBaghbani
MahdiBaghbani deleted the spec-openapi-diagrams-nav branch July 23, 2026 08:27
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