-
Notifications
You must be signed in to change notification settings - Fork 17
fix: sync discovery schema/spec with IETF-RFC.md #317
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
base: develop
Are you sure you want to change the base?
Conversation
- Fix Appendix D Provider diagram tokens/fields to match the draft (tokenEndPoint, http-sig, http-request-signatures, publicKeys[]) - Align spec.yaml wording/examples with the draft (capability tokens, accessTypes, tokenEndPoint URL vs inviteAcceptDialog path) - Move discovery schema to schemas/ocm-discovery.jsonc with draft-strict URL rules Signed-off-by: Mahdi Baghbani <[email protected]>
Signed-off-by: Mahdi Baghbani <[email protected]>
Signed-off-by: Mahdi Baghbani <[email protected]>
glpatcern
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Mahdi (and happy new year!). I have a comment on the comments ;)
| @@ -0,0 +1,88 @@ | |||
| { | |||
| // Discovery schema for OCM API Discovery (JSON Schema, JSONC for comments). | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need to add comments here? This is possibly to be brought to the WG chairs, also to understand how to evolve the spec and keep things aligned between the I-D, the OpenAPI file and the JSON schemas here.
Maybe I'd take this change out of the PR as the rest is pretty much good to go, and then we discuss this on its own.
| | - shareTypes[] | | - exchange-token | | | ||
| | - protocols{} | | - http-sig | | | ||
| +------------------+ | - invites | | | ||
| | | - notifications | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to see this diagram updated :) the concern is whether to put some ... and refer to the single source of truth in the same document, to avoid this part to drift?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I'll do it!
Sorry I was late to read the previous PR and missed some details, here are my fixes:
Draft consistency fixes (
IETF-RFC.md)tokenEndPoint,http-sig,http-request-signatures).OpenAPI alignment (
spec.yaml)accessTypesplural, andtokenEndPointwording + examples).inviteAcceptDialogis a path,tokenEndPointis an absolute URL.Discovery JSON Schema becomes JSONC and follows the draft strictly (
schemas/ocm-discovery.jsonc)inviteAcceptDialogmust start with/,tokenEndPointmust behttp(s)://....publicKey(deprecated) and RFC 9421publicKeys[].