Skip to content

Commit

Permalink
Update 3.1.0 docs (#6239)
Browse files Browse the repository at this point in the history
Co-authored-by: Ben Brooks <ben.brooks@couchbase.com>
  • Loading branch information
torcolvin and bbrks authored May 12, 2023
1 parent 2a9837d commit 341f20f
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 24 deletions.
67 changes: 43 additions & 24 deletions docs/api/components/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,11 @@ User:
description: A set of access grants by scope and collection.
type: object
additionalProperties:
x-additionalPropertiesName: scopename
description: An object keyed by scope, containing a set of collections.
type: object
additionalProperties:
x-additionalPropertiesName: collectionname
$ref: '#/CollectionAccessConfig'
email:
description: The email address of the user.
Expand Down Expand Up @@ -345,9 +347,11 @@ Role:
description: A set of access grants by scope and collection.
type: object
additionalProperties:
x-additionalPropertiesName: scopename
description: An object keyed by scope, containing a set of collections.
type: object
additionalProperties:
x-additionalPropertiesName: collectionname
$ref: '#/CollectionAccessConfig'
title: Role
User-session-information:
Expand Down Expand Up @@ -465,6 +469,7 @@ Document:
_attachments:
type: object
additionalProperties:
x-additionalPropertiesName: attachmentname
description: The name of the attachment.
type: object
properties:
Expand Down Expand Up @@ -529,15 +534,15 @@ Design-doc:
type: string
views:
type: object
properties:
additionalProperties:
description: The name of the view.
type: object
properties:
map:
type: string
reduce:
type: string
additionalProperties:
x-additionalPropertiesName: viewname
description: The name of the view.
type: object
properties:
map:
type: string
reduce:
type: string
options:
type: object
properties:
Expand Down Expand Up @@ -1078,19 +1083,24 @@ Replication-status:
- replication_id
title: Replication-status
Scopes:
description: A map of all the collections with their corresponding configs for this scope
description: Scope-specific configuration.
type: object
additionalProperties:
$ref: '#/CollectionConfig'
properties:
collections:
description: An object keyed by collection name containing config for the specific collection.
type: object
additionalProperties:
x-additionalPropertiesName: collectionname
$ref: '#/CollectionConfig'
title: Scopes
CollectionConfig:
description: The configuration for the individual collection
description: Collection-specific configuration.
type: object
properties:
sync:
description: The Javascript function that newly created documents in this collection are ran through.
type: string
example: 'function(doc){channel(doc.channels);}'
example: 'function(doc){channel("collection name");}'
import_filter:
description: |-
This is the function that all imported documents in this collection are ran through in order to filter out what to import and what not to import. This allows you to control what is made available to Couchbase Mobile clients. If it is not set, then no documents are filtered when imported.
Expand Down Expand Up @@ -1156,23 +1166,27 @@ Database:
type: integer
default: 1000
scopes:
description: Scope and collection specific config.
description: An object keyed by scope name containing config for the specific collection.
type: object
properties:
additionalProperties:
$ref: '#/Scopes'
additionalProperties:
x-additionalPropertiesName: scopename
$ref: '#/Scopes'
name:
description: The name of the database.
type: string
sync:
description: The Javascript function that newly created documents are ran through for the _default scope and collection.
description: The Javascript function that newly created documents are ran through for the default scope and collection.

If `scopes` parameter is set, this is ignored.
type: string
default: 'function(doc){channel(doc.channels);}'
users:
additionalProperties:
x-additionalPropertiesName: username
$ref: '#/User'
roles:
additionalProperties:
x-additionalPropertiesName: rolename
$ref: '#/Role'
revs_limit:
description: |-
Expand Down Expand Up @@ -1203,9 +1217,11 @@ Database:
default: 16
import_filter:
description: |-
This is the function that all imported documents in the _default scope and collection are ran through in order to filter out what to import and what not to import. This allows you to control what is made available to Couchbase Mobile clients. If it is not set, then no documents are filtered when imported.
This is the function that all imported documents in the default scope and collection are ran through in order to filter out what to import and what not to import. This allows you to control what is made available to Couchbase Mobile clients. If it is not set, then no documents are filtered when imported.
`import_docs` must be true to make this field applicable.
If `scopes` parameter is set, this is ignored.
type: string
example: 'function(doc) { if (doc.type != ''mobile'') { return false; } return true; }'
import_backup_old_rev:
Expand All @@ -1231,8 +1247,8 @@ Database:
type: string
default: DCP
enum:
- TAP
- DCP
- TAP
deprecated: true
allow_empty_password:
description: This controls whether users that are created can have an empty password or not.
Expand Down Expand Up @@ -1443,6 +1459,7 @@ Database:
description: Configuration for Local JWT authentication.
type: object
additionalProperties:
x-additionalPropertiesName: providername
description: The providers name.
type: object
required: ['issuer', 'client_id', 'algorithms', 'keys']
Expand Down Expand Up @@ -1529,6 +1546,7 @@ Database:
description: List of OpenID Connect issuers.
type: object
additionalProperties:
x-additionalPropertiesName: providername
description: The providers name.
type: object
properties:
Expand Down Expand Up @@ -1765,9 +1783,8 @@ Event-config:
options:
description: The options for the event.
type: object
properties:
additionalProperties:
description: The option key and value.
additionalProperties:
description: The option key and value.
title: Event-config
Resync-status:
description: The status of a resync operation
Expand Down Expand Up @@ -2124,12 +2141,14 @@ Startup-config:
description: 'A map of database name to credentials, that can be used instead of the bootstrap ones.'
type: object
additionalProperties:
x-additionalPropertiesName: databasename
$ref: '#/CredentialsConfig'
readOnly: true
bucket_credentials:
description: 'A map of bucket names to credentials, that can be used instead of the bootstrap ones.'
type: object
additionalProperties:
x-additionalPropertiesName: bucketname
$ref: '#/CredentialsConfig'
readOnly: true
max_file_descriptors:
Expand Down
1 change: 1 addition & 0 deletions docs/api/paths/admin/_post_upgrade.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ post:
description: A map of databases.
type: object
additionalProperties:
x-additionalPropertiesName: db
description: The name of the database that was targetted.
type: object
properties:
Expand Down

0 comments on commit 341f20f

Please sign in to comment.