Skip to content

Commit e80e58f

Browse files
Further fixes and clarifications following #244 (#249)
Co-authored-by: Mahdi Baghbani <Mahdi.baghbani1@gmail.com>
1 parent d185cce commit e80e58f

2 files changed

Lines changed: 12 additions & 20 deletions

File tree

IETF-RFC.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -466,8 +466,8 @@ field of an Invite Acceptance Request.
466466

467467
Step 1: In case it has an OCM Address, it SHOULD first extract `<fqdn>`
468468
from it (the part after the last `@` sign).
469-
Step 2: The Discovering Server SHOULD attempt OCM API Discovery a HTTP
470-
GET request to `https://<fqdn>/.well-known/ocm`.
469+
Step 2: The Discovering Server SHOULD attempt OCM API Discovery via a
470+
HTTP GET request to `https://<fqdn>/.well-known/ocm`.
471471
Step 3: If that results in a valid HTTP response with a valid JSON
472472
response body within reasonable time, go to step 7.
473473
Step 4: If not, try a HTTP GET with `https://<fqdn>/ocm-provider` as
@@ -616,10 +616,9 @@ with the fields as described below
616616

617617
* REQUIRED shareWith (string)
618618
OCM Address of the user, group or federation
619-
the provider wants to share the Resource with. This is known
620-
in advance. Please note that the consumer service endpoint is
621-
known in advance as well, so this is no part of the request
622-
body.
619+
the provider wants to share the Resource with. This MUST be
620+
known in advance, either via a previous Invitation or through
621+
other means.
623622
Example: "51dc30ddc473d43a6011e9ebba6ca770@geant.org"
624623
* REQUIRED name (string)
625624
Name of the Resource (file or folder).
@@ -640,9 +639,7 @@ with the fields as described below
640639
Example: "6358b71804dfa8ab069cf05ed1b0ed2a@apiwise.nl"
641640
* REQUIRED sender (string) -
642641
OCM Address of the user that wants to share
643-
the Resource. Please note that the requesting provider is
644-
being identified on a higher level, so the former `remote`
645-
property is not part of the request body.
642+
the Resource.
646643
Example: "527bd5b5d689e2c32ae974c6229ff785@apiwise.nl"
647644
* OPTIONAL ownerDisplayName (string)
648645
Display name of the owner of the Resource
@@ -652,7 +649,7 @@ with the fields as described below
652649
Example: "John Doe"
653650
* REQUIRED shareType (string)
654651
SHOULD have a value of "user", "group", or "federation", to
655-
indicated that the first part of the `shareWith` OCM Address
652+
indicate that the first part of the `shareWith` OCM Address
656653
refers to a Receiving Party who is a single user of the
657654
Receiving Server, a group of users at the Receiving Servers, or
658655
a group of users that is spread out over various servers,

spec.yaml

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -490,10 +490,8 @@ components:
490490
type: string
491491
description: >
492492
OCM Address of the user, group or federation the
493-
provider
494-
wants to share the resource with. This is known in advance.
495-
Please note that the consumer service endpoint is known in advance
496-
as well, so this is no part of the request body.
493+
provider wants to share the resource with. This MUST be known
494+
in advance, either via a previous Invitation or through other means.
497495
example: 51dc30ddc473d43a6011e9ebba6ca770@geant.org
498496
name:
499497
type: string
@@ -509,9 +507,8 @@ components:
509507
type: string
510508
description: >
511509
Identifier to identify the shared resource at the provider side.
512-
This is
513-
unique per provider such that if the same resource is shared twice,
514-
this providerId will not be repeated.
510+
This is unique per provider such that if the same resource is shared
511+
twice, this providerId will not be repeated.
515512
example: 7c084226-d9a1-11e6-bf26-cec0c932ce01
516513
owner:
517514
description: |
@@ -521,9 +518,7 @@ components:
521518
sender:
522519
description: |
523520
OCM Address of the user that wants to share the
524-
resource. Please note that the requesting provider is being
525-
identified on a higher level, so the former `remote` property
526-
is not part of the request body.
521+
resource.
527522
type: string
528523
example: 527bd5b5d689e2c32ae974c6229ff785@apiwise.nl
529524
ownerDisplayName:

0 commit comments

Comments
 (0)