Skip to content

Commit 5a9ec43

Browse files
committed
Align with new additons to the spec, especially signing
1 parent 0b4b62c commit 5a9ec43

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

IETF-RFC.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1973,12 +1973,15 @@ The complete changelog is updated in the OCM-API GitHub repository.
19731973
* Added JSContact extension to IANA Considerations.
19741974
* Changed example domain to use cloud.example.org per RFC 2606.
19751975

1976-
# Appendix D: Resource Discovery Service
1976+
# Appendix E: Resource Discovery Service
19771977

19781978
An OCM Server MAY publicly advertise available resources.
19791979
This is done via the `resourceAdvertismentUri`. It is
1980-
expected to expose, via anonymous HTTP GET, a JSON document
1981-
with the following format:
1980+
expected to expose, via anonymous HTTPS GET, a signed JWS
1981+
document [RFC7515], where the signing key MUST be made
1982+
available via the `/.well-known/jwks.json` of the
1983+
advertising server and the payload MUST adhere to the
1984+
following format:
19821985

19831986
* REQUIRED: `server` - a human-readable name for the
19841987
Servers providing the Resource Discovery Service
@@ -2000,7 +2003,7 @@ with the following format:
20002003
"server": "OCM Server 1",
20012004
"resources": [
20022005
{
2003-
"publicUrl": "https://ocm-server-1.fqdn/s/1234567890abcdef",
2006+
"publicUrl": "https://cloud.example.org/s/1234567890abcdef",
20042007
"displayName": "Public Dataset 1",
20052008
"id": "1234567890abcdef",
20062009
"rocrate": {
@@ -2022,7 +2025,7 @@ with the following format:
20222025
"name": "A RO-Crate embedded in OCM"
20232026
},
20242027
{
2025-
"@id": "https://ocm-server-1.fqdn/s/1234567890abcdef",
2028+
"@id": "https://cloud.example.org/s/1234567890abcdef",
20262029
"@type": "File",
20272030
"name": "Public data file"
20282031
}

spec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ components:
311311
resourceadvertismenturi:
312312
type: string
313313
description: the uri of the ocm resources advertised at this endpoint
314-
example: https://my-cloud-storage.org/ocm/resources
314+
example: https://cloud.example.org/ocm/resources
315315
resourceTypes:
316316
type: array
317317
description: |

0 commit comments

Comments
 (0)