Skip to content

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.

Sign up for GitHub

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

Open
MahdiBaghbani wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

fix: sync discovery schema/spec with IETF-RFC.md #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64909db
fix: sync discovery schema/spec with IETF-RFC.md
MahdiBaghbani Dec 31, 2025
6282588
rtemove: spec.json, this would be another pr later
MahdiBaghbani Dec 31, 2025
615192e
fix: linter max size
MahdiBaghbani Dec 31, 2025
e93de04
fix(discovery): revert to JSON, use jwks, add diagram ref
MahdiBaghbani Feb 19, 2026
4802dd5
Merge branch 'develop' into mahdi/fix/inconsistencies
MahdiBaghbani Feb 19, 2026
4ce1af8
docs: mention the single source of truth in diagrams
MahdiBaghbani Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 36 additions & 11 deletions IETF-RFC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1703,6 +1703,12 @@ implementor might find it useful to have a Provider object model to
store the discovered information about federation peers or other remote
OCM Providers.

The following diagram is illustrative and non-exhaustive. The single
source of truth for Provider properties is the OCM API Discovery Fields
section; for the box contents below, see the Properties subsection and
the normative capability, criteria, and resource type definitions in
that section.

~~~
+-----------------------+
| Provider |
Expand All @@ -1714,23 +1720,42 @@ OCM Providers.
| - inviteAcceptDialog |
| - provider |
| - publicKey |
| - tokenEndpoint |
| - tokenEndPoint |
| - ... |
+-----------------------+
|
| exposes
|
+---------+---------+----------------------+
| | |
v v v
+------------------+ +------------------+ +------------------+
| ResourceTypes[] | | Capabilities[] | | Criteria[] |
+------------------+ +------------------+ +------------------+
| - name | | - enforce-mfa | | - allowlist |
| - shareTypes[] | | - exchange-token | | - denylist |
| - protocols{} | | - invite-wayf | | - http-signatures|
+------------------+ | - invites | | - invite |
| | - webdav-uri | | - token-exchange |
| +------------------+ +------------------+
v v |
+------------------+ +------------------+ |
| ResourceTypes[] | | Capabilities[] | |
+------------------+ +------------------+ |
| - name | | - enforce-mfa | |
| - shareTypes[] | | - exchange-token | |
| - protocols{} | | - http-sig | |
| - ... | | - invites | |
+------------------+ | - notifications | |
| | - protocol-object| |
| | - webdav-uri | |
| | - ... | |
| +------------------+ |
| |
| +----------------+
| |
| v
| +--------------------------+
| | Criteria[] |
| +--------------------------+
| | - allowlist |
| | - denylist |
| | - http-request-signatures|
| | - invite |
| | - token-exchange |
| | - ... |
| +--------------------------+
|
| supports
v
+------------------+
Expand Down
15 changes: 7 additions & 8 deletions schemas/ocm-discovery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"type": "string"
},
"endPoint": {
"type": "string",
"type": "string",
"format": "uri"
},
"provider": {
Expand All @@ -35,7 +35,7 @@
}
},
"publicKey": {
"$ref": "#/$defs/publicKey"
"$ref": "#/$defs/publicKey"
},
"inviteAcceptDialog": {
"type": "string",
Expand All @@ -47,9 +47,9 @@
}
},
"required": [
"enabled",
"apiVersion",
"endPoint",
"enabled",
"apiVersion",
"endPoint",
"resourceTypes"
],
"$defs": {
Expand Down Expand Up @@ -94,8 +94,7 @@
"type": "string"
}
},
"required": ["keyId", "publicKeyPem" ]

"required": ["keyId", "publicKeyPem"]
}
}
}
}
6 changes: 3 additions & 3 deletions spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ components:
type: string
format: uri
description: >
Optional URL path of the Token Exchange endpoint to obtain bearer tokens in exchange for codes.
Optional URL of the Token Exchange endpoint to obtain bearer tokens in exchange for codes.
If the `exchange-token` capability is exposed, the tokenEndPoint MUST be advertised in the discovery response.

**Token Exchange API:**
Expand All @@ -466,7 +466,7 @@ components:
- 400: Token denied (application/json with Error schema)

See TokenRequest and TokenResponse schemas for the complete data structure.
example: /index.php/apps/sciencemesh/token
example: https://cloud.example.org/ocm/token
inviteAcceptDialog:
type: string
description: >
Expand Down Expand Up @@ -756,7 +756,7 @@ components:
sharedSecret: hfiuhworzwnur98d3wjiwhr
viewMode: read
ssh:
accessType: ['datatx']
accessTypes: ['datatx']
uri: extuser@cloud.example.org:/7c084226-d9a1-11e6-bf26-cec0c932ce01
NewNotification:
type: object
Expand Down
Loading