Skip to content

Commit 8a81915

Browse files
Change my-cloud-storage.org -> cloud.example.org (#316)
* Change my-cloud-storage.org -> cloud.example.org According to the Internet-Draft Author Resources at: https://authors.ietf.org/en/example-addresses and RFC 2606: https://datatracker.ietf.org/doc/rfc2606/ we should use appointed example domain names and for these examples a second level example domain is appropriate, and .org is used here as the tld as in the previous examples. * One more example.com cleaned up --------- Co-authored-by: Giuseppe Lo Presti <[email protected]>
1 parent d154140 commit 8a81915

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

IETF-RFC.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ related concepts from OAuth [RFC6749] and elsewhere:
131131
another reason.
132132
* __Sharing User__ - A user providing access to a Resource through a
133133
Share.
134-
* __FQDN__ - Fully Qualified Domain Name, such as `"cloud.example.com"`.
134+
* __FQDN__ - Fully Qualified Domain Name, such as `"cloud.example.org"`.
135135
* __OCM Server__ - A server that supports OCM.
136136
* __OCM API Discovery__ - Process of evaluating properties of a Remote
137137
Resource, after establishing contact with an OCM Server.
@@ -439,8 +439,8 @@ and a `provider`. There are two recognized formats:
439439
joined by an `@` sign. Example:
440440

441441
If the `token` is `a55a966e-15c1-4cb9-a39d-4e4c54399baf` and the
442-
`provider` is `my-cloud-storage.org`, the combined string is
443-
`a55a966e-15c1-4cb9-a39d-4e4c54399baf@my-cloud-storage.org`,
442+
`provider` is `cloud.example.org`, the combined string is
443+
`a55a966e-15c1-4cb9-a39d-4e4c54399baf@cloud.example.org`,
444444
which when base64-encoded becomes
445445
`YTU1YTk2NmUtMTVjMS00Y2I5LWEzOWQtNGU0YzU0Mzk5YmFmQG15LWNsb3VkLXN0b
446446
3JhZ2Uub3Jn`.
@@ -453,7 +453,7 @@ and a `provider`. There are two recognized formats:
453453
If the inviting OCM Server supports a WAYF page, the invite may be
454454
provided as a link with the token as a request parameter. Example:
455455

456-
`https://my-cloud-storage.org/wayf?token=
456+
`https://cloud.example.org/wayf?token=
457457
a55a966e-15c1-4cb9-a39d-4e4c54399baf`
458458

459459
Implementations MUST be able to accept invites in the invite string
@@ -582,7 +582,7 @@ contain the following information about its OCM API:
582582
* REQUIRED: apiVersion (string) - The OCM API version this endpoint
583583
supports. Example: `"1.2.2"`
584584
* REQUIRED: endPoint (string) - The URI of the OCM API available at
585-
this endpoint. Example: `"https://my-cloud-storage.org/ocm"`
585+
this endpoint. Example: `"https://cloud.example.org/ocm"`
586586
* OPTIONAL: provider (string) - A friendly branding name of this
587587
endpoint. Example: `"MyCloudStorage"`
588588
* REQUIRED: resourceTypes (array) - A list of all resource types this
@@ -685,7 +685,7 @@ contain the following information about its OCM API:
685685
- REQUIRED keyId (string) unique id of the key in URI format. The
686686
hostname set the origin of the request and MUST be
687687
identical to the current discovery endpoint.
688-
Example: https://my-cloud-storage.org/ocm#signature
688+
Example: https://cloud.example.org/ocm#signature
689689
- REQUIRED publicKeyPem (string) - PEM-encoded RSA public key for
690690
draft-cavage signatures.
691691
Example:
@@ -697,7 +697,7 @@ contain the following information about its OCM API:
697697
is present. Each object in the array MUST contain:
698698
- REQUIRED keyId (string) - Unique identifier for this key in URI
699699
format. Hostname MUST match the discovery endpoint hostname.
700-
Example: https://my-cloud-storage.org/ocm#key-1
700+
Example: https://cloud.example.org/ocm#key-1
701701
- REQUIRED publicKeyPem (string) - PEM-encoded public key for
702702
[RFC9421] signatures.
703703
Example:
@@ -712,13 +712,13 @@ contain the following information about its OCM API:
712712
`"invites"` capability SHOULD provide this URL as well in order to
713713
enhance the UX of the Invite Flow. If for example
714714
`"/index.php/apps/sciencemesh/accept"` is specified here then a WAYF
715-
Page SHOULD redirect the end-user to
716-
`/index.php/apps/sciencemesh/accept?token=zi5kooKu3ivohr9a&providerDomain=example.com`.
715+
Page SHOULD redirect the end-user to `/index.php/apps/sciencemesh/
716+
accept?token=zi5kooKu3ivohr9a&providerDomain=cloud.example.org`.
717717
* OPTIONAL: tokenEndPoint (string) - URL of the token endpoint where the
718718
Sending Server can exchange a secret for a short-lived bearer token.
719719
Implementations that offer the `"exchange-token"` capability MUST
720720
provide this URL as well.
721-
Example: `"https://my-cloud-storage.org/ocm/token"`.
721+
Example: `"https://cloud.example.org/ocm/token"`.
722722

723723
# Share Creation Notification
724724

@@ -1072,7 +1072,7 @@ follows an example of such POST request:
10721072

10731073
```
10741074
POST {tokenEndPoint} HTTP/1.1
1075-
Host: my-cloud-storage.org
1075+
Host: cloud.example.org
10761076
Date: Wed, 05 Nov 2025 14:00:00 GMT
10771077
Content-Type: application/x-www-form-urlencoded
10781078
Digest: SHA-256=ok6mQ3WZzKc8nb7s/Jt2yY1uK7d2n8Zq7dhl3Q0s1xk=

spec.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ servers:
1212
- url: https://{discovery_fqdn}
1313
variables:
1414
discovery_fqdn:
15-
default: my-cloud-storage.org
15+
default: cloud.example.org
1616
paths:
1717
/.well-known/ocm:
1818
get:
@@ -21,7 +21,7 @@ paths:
2121
Following [RFC8615], this endpoint returns the properties and
2222
capabilities offered by an OCM Server. This endpoint MUST be
2323
served at the OCM Server's root FQDN, e.g. as in
24-
`https://my-cloud-storage.org/.well-known/ocm`. See [OCM API Discovery](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md#ocm-api-discovery)
24+
`https://cloud.example.org/.well-known/ocm`. See [OCM API Discovery](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md#ocm-api-discovery)
2525
for more details.
2626
responses:
2727
"200":
@@ -312,7 +312,7 @@ components:
312312
endPoint:
313313
type: string
314314
description: The URI of the OCM API available at this endpoint
315-
example: https://my-cloud-storage.org/ocm
315+
example: https://cloud.example.org/ocm
316316
provider:
317317
type: string
318318
description: A friendly branding name of this endpoint
@@ -435,7 +435,7 @@ components:
435435
description: >
436436
unique id of the key in URI format. The hostname set the origin
437437
of the request and MUST be identical to the current discovery endpoint.
438-
example: https://my-cloud-storage.org/ocm#signature
438+
example: https://cloud.example.org/ocm#signature
439439
publicKeyPem:
440440
type: string
441441
description: |
@@ -463,7 +463,7 @@ components:
463463
description: >
464464
Unique identifier for this key in URI format.
465465
Hostname MUST match the discovery endpoint hostname.
466-
example: https://my-cloud-storage.org/ocm#key-1
466+
example: https://cloud.example.org/ocm#key-1
467467
publicKeyPem:
468468
type: string
469469
description: |
@@ -789,8 +789,8 @@ components:
789789
sharedSecret: hfiuhworzwnur98d3wjiwhr
790790
viewMode: read
791791
ssh:
792-
accessTypes: ['datatx']
793-
uri: extuser@my-cloud-storage.org:/7c084226-d9a1-11e6-bf26-cec0c932ce01
792+
accessType: ['datatx']
793+
uri: extuser@cloud.example.org:/7c084226-d9a1-11e6-bf26-cec0c932ce01
794794
NewNotification:
795795
type: object
796796
required:

0 commit comments

Comments
 (0)