Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mohammed-madi committed May 16, 2024
1 parent c6f1aeb commit eb9953f
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 30 deletions.
2 changes: 0 additions & 2 deletions docs/api/admin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ paths:
$ref: './paths/admin/db-_user-.yaml'
'/{db}/_user/{name}':
$ref: './paths/admin/db-_user-name.yaml'
'/{db}/_user/{name}/all_channels':
$ref: './paths/admin/db-_user-name-all_channels.yaml'
'/{db}/_user/{name}/_session':
$ref: './paths/admin/db-_user-name-_session.yaml'
'/{db}/_user/{name}/_session/{sessionid}':
Expand Down
6 changes: 6 additions & 0 deletions docs/api/components/responses.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -180,3 +180,9 @@ DB-config-precondition-failed:
example:
error: Precondition Failed
reason: Provided If-Match header does not match current config version
All_user_channels_response:
description: Map of all keyspaces to all channels that the user has access to in the, and their properties.
content:
application/json:
schema:
$ref: ./schemas.yaml#/All_user_channels_response
25 changes: 25 additions & 0 deletions docs/api/components/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2512,3 +2512,28 @@ CollectionNames:
- Starting
- Stopping
- Resyncing
All_user_channels_response:
description: |-
All user channels split by how they were assigned to the user and by keyspace.
type: object
properties:
all_channels:
description: |-
All channels that the user has access to.
type: object
properties:
keyspace:
type: object
properties:
channel:
$ref: '#/channelEntry'
channelEntry:
description: Channel name
type: object
properties:
entries:
type: array
description: Start sequence to end sequence
updated_at:
type: integer
description: Unix timestamp of last update
2 changes: 2 additions & 0 deletions docs/api/diagnostic.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ paths:
$ref: './paths/diagnostic/keyspace-sync.yaml'
'/{keyspace}/import_filter':
$ref: './paths/diagnostic/keyspace-import_filter.yaml'
'/{db}/_user/{name}/all_channels':
$ref: './paths/diagnostic/db-_user-name-_all_channels.yaml'

Check failure on line 40 in docs/api/diagnostic.yaml

View workflow job for this annotation

GitHub Actions / OpenAPI Validation

Can't resolve $ref: ENOENT: no such file or directory '/github/workspace/docs/api/paths/diagnostic/db-_user-name-_all_channels.yaml'

Check failure on line 40 in docs/api/diagnostic.yaml

View workflow job for this annotation

GitHub Actions / OpenAPI Validation

Can't resolve $ref: ENOENT: no such file or directory '/github/workspace/docs/api/paths/diagnostic/db-_user-name-_all_channels.yaml'

Check failure on line 40 in docs/api/diagnostic.yaml

View workflow job for this annotation

GitHub Actions / OpenAPI Validation

Can't resolve $ref: ENOENT: no such file or directory '/github/workspace/docs/api/paths/diagnostic/db-_user-name-_all_channels.yaml'

Check failure on line 40 in docs/api/diagnostic.yaml

View workflow job for this annotation

GitHub Actions / OpenAPI Validation

Can't resolve $ref: ENOENT: no such file or directory '/github/workspace/docs/api/paths/diagnostic/db-_user-name-_all_channels.yaml'
externalDocs:
description: Sync Gateway Quickstart | Couchbase Docs
url: 'https://docs.couchbase.com/sync-gateway/current/index.html'
28 changes: 0 additions & 28 deletions docs/api/paths/admin/db-_user-name-all_channels.yaml

This file was deleted.

0 comments on commit eb9953f

Please sign in to comment.