Skip to content

Commit 9e159de

Browse files
torcolvinsimon-dew
andauthored
DOC-11383 clarify use of admin_channels with collection_access (#7473)
Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>
1 parent 7663600 commit 9e159de

File tree

1 file changed

+49
-52
lines changed

1 file changed

+49
-52
lines changed

docs/api/components/schemas.yaml

Lines changed: 49 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -259,35 +259,30 @@ User:
259259
Mandatory. unless `allow_empty_password` is `true` in the database configs.
260260
type: string
261261
admin_channels:
262-
description: A list of channels to explicitly grant to the user for the default collection.
262+
description: |-
263+
A list of channels to explicitly grant to the user for the default collection.
264+
See `collection_access` for channels in named collections.
263265
type: array
264266
items:
265267
type: string
266268
all_channels:
267269
description: |-
268270
All the channels that the user has been granted access to for the default collection.
271+
See `collection_access` for channels in named collections.
269272
270273
Access could have been granted through the sync function, roles, or explicitly on the user under the `admin_channels` property.
271274
type: array
272275
items:
273276
type: string
274277
readOnly: true
275-
collection_access:
276-
description: A set of access grants by scope and collection.
277-
type: object
278-
additionalProperties:
279-
x-additionalPropertiesName: scopename
280-
description: An object keyed by scope, containing a set of collections.
281-
type: object
282-
additionalProperties:
283-
x-additionalPropertiesName: collectionname
284-
$ref: '#/CollectionAccessConfig'
278+
$ref: '#/CollectionAccessConfig'
285279
email:
286280
description: The email address of the user.
287281
type: string
288282
disabled:
289283
description: 'If true, the user will not be able to login to the account as it is disabled.'
290284
type: boolean
285+
default: false
291286
admin_roles:
292287
description: A list of roles to explicitly grant to the user.
293288
type: array
@@ -309,7 +304,7 @@ User:
309304
type: string
310305
readOnly: true
311306
jwt_channels:
312-
description: The channels that the user has been granted access to through channels_claim.
307+
description: The channels that the user has been granted access to through channels_claim for the default collection.
313308
type: array
314309
items:
315310
type: string
@@ -325,34 +320,44 @@ User:
325320
readOnly: true
326321
title: User
327322
CollectionAccessConfig:
328-
description: An object keyed by collection name, defines access for the collection.
329-
type: object
330-
properties:
331-
admin_channels:
332-
description: A list of channels to explicitly grant to the user.
333-
type: array
334-
items:
335-
type: string
336-
all_channels:
337-
description: |-
338-
All the channels that the user has been granted access to.
323+
collection_access:
324+
description: A set of access grants by scope and collection for a specific collection.
325+
type: object
326+
additionalProperties:
327+
maxProperties: 1
328+
description: An object keyed by scope, containing a set of collections.
329+
type: object
330+
x-additionalPropertiesName: scopename
331+
additionalProperties:
332+
description: An object keyed by collection name, defines access collections in this scope.
333+
type: object
334+
x-additionalPropertiesName: collectionname
335+
properties:
336+
admin_channels:
337+
description: A list of channels to explicitly grant to the user in this collection.
338+
type: array
339+
items:
340+
type: string
341+
all_channels:
342+
description: |-
343+
All the channels that the user has been granted access to in this collection.
339344
340-
Access could have been granted through the sync function, roles, or explicitly on the user under the `admin_channels` property.
341-
type: array
342-
items:
343-
type: string
344-
readOnly: true
345-
jwt_channels:
346-
description: The channels that the user has been granted access to through channels_claim.
347-
type: array
348-
items:
349-
type: string
350-
readOnly: true
351-
jwt_last_updated:
352-
description: The last time that the user's JWT roles/channels were updated.
353-
type: string
354-
format: date-time
355-
readOnly: true
345+
Access could have been granted through the sync function, roles, or explicitly on the user under the `admin_channels` property.
346+
type: array
347+
items:
348+
type: string
349+
readOnly: true
350+
jwt_channels:
351+
description: The channels that the user has been granted access to through channels_claim for this collection.
352+
type: array
353+
items:
354+
type: string
355+
readOnly: true
356+
jwt_last_updated:
357+
description: The last time that the user's JWT channels were updated for this collection.
358+
type: string
359+
format: date-time
360+
readOnly: true
356361
Role:
357362
description: Properties associated with a role
358363
type: object
@@ -364,30 +369,22 @@ Role:
364369
Role names can only have alphanumeric ASCII characters and underscores.
365370
type: string
366371
admin_channels:
367-
description: The channels that users in the role are able to access for the default collection.
372+
description: |-
373+
A list of channels to explicitly grant to the role for the default collection.
374+
See `collection_access` for channels in named collections.
368375
type: array
369376
items:
370377
type: string
371378
all_channels:
372379
description: |-
373-
The channels that the role grants access to for the default collection.
380+
All the channels that the role has been granted access to for the default collection.
374381
375382
These channels could have been assigned by the Sync function or using the `admin_channels` property.
376383
type: array
377384
items:
378385
type: string
379386
readOnly: true
380-
collection_access:
381-
description: A set of access grants by scope and collection.
382-
type: object
383-
additionalProperties:
384-
x-additionalPropertiesName: scopename
385-
description: An object keyed by scope, containing a set of collections.
386-
type: object
387-
additionalProperties:
388-
x-additionalPropertiesName: collectionname
389-
allOf:
390-
- $ref: '#/CollectionAccessConfig'
387+
$ref: '#/CollectionAccessConfig'
391388
title: Role
392389
User-session-information:
393390
type: object

0 commit comments

Comments
 (0)