Skip to content

Commit

Permalink
Add missing doc page and fix lint
Browse files Browse the repository at this point in the history
  • Loading branch information
mohammed-madi committed Mar 11, 2024
1 parent d091931 commit 065dc96
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 1 deletion.
61 changes: 61 additions & 0 deletions docs/api/paths/diagnostic/keyspace-sync.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Copyright 2024-Present Couchbase, Inc.
#
# Use of this software is governed by the Business Source License included
# in the file licenses/BSL-Couchbase.txt. As of the Change Date specified
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.
parameters:
- $ref: ../../components/parameters.yaml#/keyspace
get:
summary: Run a doc body through the sync function and return sync data.
description: |-
Run a document body through the sync function and return document sync data.
* Sync Gateway Application Read Only
requestBody:
content:
application/json:
schema:
$ref: ../../components/schemas.yaml#/Document
responses:
'200':
description: Document Processed by sync function successfully
content:
application/json:
schema:
type: object
properties:
channels:
description: The channels the document was placed in by the sync function.
type: array
roles:
description: An access map of roles granted by the sync function.
type: object
properties:
username:
type: object
additionalProperties:
x-additionalPropertiesName: role
type: string
access:
description: An access map of dynamic channels granted by the sync function.
type: object
properties:
username:
type: object
additionalProperties:
x-additionalPropertiesName: channel
type: string

exception:
description: Errors thrown by the sync function.
type: string

'404':
$ref: ../../components/responses.yaml#/Not-found
parameters:
- $ref: ../../components/parameters.yaml#/docid
- $ref: ../../components/parameters.yaml#/rev
tags:
- Document
operationId: get_keyspace-sync
2 changes: 1 addition & 1 deletion rest/diagnostic_doc_api.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func (h *handler) handleSyncFnDryRun() error {
access,
roles,
errorMsg,
uint32(expiry),
expiry,
}

h.writeJSON(resp)
Expand Down

0 comments on commit 065dc96

Please sign in to comment.