Skip to content

Commit b85b9ef

Browse files
fix: description based on IETF I-D (#233)
* fix: description based on IETF I-D * Dropped example as it's already present * Shortened example list * Merge pull request #3 from glpatcern/patch-1 Clarified use of file vs folder --------- Co-authored-by: Giuseppe Lo Presti <[email protected]>
1 parent b174da3 commit b85b9ef

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

IETF-RFC.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ We define the following concepts (with some non-normative references to
6060
related concepts from OAuth and elsewhere):
6161

6262
* __Resource__ - the piece of data or interaction to which access is
63-
being granted, e.g. a file, folder, video call, or printer queue
63+
being granted, including but not limited to: a file or folder, a video
64+
call, a contact, a printer queue, etc.
6465
* __Share__ - a policy rule stating that certain actors are allowed
6566
access to a Resource. Also: a record in a database representing this
6667
rule
@@ -454,7 +455,7 @@ endpoint. Example: `"MyCloudStorage"`
454455
server supports in both the Sending Server role and the Receiving
455456
Server role, with their access protocols. Each item in this list should
456457
itself be an object containing the following fields:
457-
* name (string) - A supported resource type (file, folder, calendar,
458+
* name (string) - A supported resource type (file, calendar,
458459
contact, ...).
459460
Implementations MUST offer support for at least one
460461
resource type, where `file` is the commonly supported
@@ -619,7 +620,7 @@ with the fields as described below
619620
a group of users that is spread out over various servers,
620621
including at least one user at the Receiving Server.
621622
* REQUIRED resourceType (string)
622-
Resource type (file, folder, calendar, contact, ...)
623+
Resource type (file, calendar, contact, ...)
623624
* OPTIONAL expiration (integer)
624625
The expiration time for the OCM share, in seconds
625626
of UTC time since Unix epoch. If omitted, it is assumed

spec.yaml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -348,15 +348,18 @@ components:
348348
name:
349349
type: string
350350
description: >
351-
A supported resource type (file, folder, calendar, contact,
352-
...).
353-
Implementations MUST support `file` at a minimum.
351+
A supported resource type (file, calendar, contact, ...).
352+
Implementations MUST offer support for at least one resource type,
353+
where `file` is the commonly supported one.
354+
Each resource type is identified by its `name`: the list MUST NOT
355+
contain more than one resource type object per given `name`
354356
example: file
355357
shareTypes:
356358
type: array
357359
description: |
358-
The supported recipient share types.
359-
Implementations MUST support `user` at a minimum.
360+
The supported recipient share types.
361+
MUST contain `"user"` at a minimum, plus optionally
362+
`"group"` and `"federation"`.
360363
items:
361364
type: string
362365
enum:
@@ -545,7 +548,7 @@ components:
545548
resourceType:
546549
type: string
547550
description: |
548-
Resource type (file, folder, calendar, contact, ...)
551+
Resource type (file, calendar, contact, ...)
549552
example: file
550553
expiration:
551554
type: integer
@@ -768,7 +771,7 @@ components:
768771
resourceType:
769772
type: string
770773
description: |
771-
Resource type (file, folder, user, calendar, contact, ...)
774+
Resource type (file, user, calendar, contact, ...)
772775
providerId:
773776
type: string
774777
description: |

0 commit comments

Comments
 (0)