Skip to content

Commit 330df7d

Browse files
bbrksCopilot
authored and
RIT3shSapata
committed
Correct diagnostic API routes leading underscore (#7988)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 14aa4de commit 330df7d

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

‎docs/api/diagnostic.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ paths:
3232
$ref: ./paths/common/_ping.yaml
3333
'/{keyspace}/{docid}/_all_channels':
3434
$ref: './paths/diagnostic/keyspace-docid-_all_channels.yaml'
35-
'/{keyspace}/sync':
35+
'/{keyspace}/_sync':
3636
$ref: './paths/diagnostic/keyspace-sync.yaml'
37-
'/{keyspace}/import_filter':
37+
'/{keyspace}/_import_filter':
3838
$ref: './paths/diagnostic/keyspace-import_filter.yaml'
39-
'/{db}/_user/{name}/all_channels':
39+
'/{db}/_user/{name}/_all_channels':
4040
$ref: './paths/diagnostic/db-_user-name-_all_channels.yaml'
4141
'/{keyspace}/_user/{name}':
4242
$ref: './paths/diagnostic/keyspace-_user-name.yaml'

‎docs/api/paths/diagnostic/keyspace-import_filter.yaml‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,19 @@
88
parameters:
99
- $ref: ../../components/parameters.yaml#/keyspace
1010
post:
11-
summary: Run a doc body through the Import filter and return results.
11+
summary: Dry-run Import filter for testing
1212
description: |-
13-
Runs a document body through the import filter and return whether its
14-
imported or not, and any error messages. If no custom import filter is
15-
provided in the request body, the default or user-defined import filter
16-
is used.
13+
Runs a document through the import filter and return whether it is imported or not, and any error messages.
14+
15+
If no custom import filter is provided in the request body, the default or user-defined import filter is used.
1716
1817
The document being run through the import filter can be provided in one of the following ways:
19-
| `doc` property | `doc_id` property | Behaviour |
20-
| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21-
| Set | Unset | The document body passed will be the `doc` value in the function. |
22-
| Unset | Set | The document of the given id will be fetched from the bucket/collection and will be passed in as the `doc` value in the function. If the document is not found, an error will be returned |
23-
| Set | Set | Will throw an error (only one of `doc` or `doc_id` is allowed for the import filter dry run) |
24-
| Unset | Unset | Will throw an error (at least one of `doc` or `doc_id` is required) |
18+
| `doc` property | `doc_id` property | Behaviour |
19+
| ------ |----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20+
| Set | Unset | The document body passed will be the `doc` value in the function. |
21+
| Unset | Set | The document of the given id will be fetched from the bucket/collection and will be passed in as the `doc` value in the function. If the document is not found, an error will be returned |
22+
| Set | Set | Will throw an error (only one of `doc` or `doc_id` is allowed for the import filter dry run) |
23+
| Unset | Unset | Will throw an error (at least one of `doc` or `doc_id` is required) |
2524
2625
* Sync Gateway Application Read Only
2726
requestBody:

‎docs/api/paths/diagnostic/keyspace-sync.yaml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,19 @@
88
parameters:
99
- $ref: ../../components/parameters.yaml#/keyspace
1010
post:
11-
summary: Run a doc body through the sync function and return sync data.
11+
summary: Dry-run Sync Function for testing
1212
description: |-
13-
Runs a document body through the sync function and returns resulting sync function data. If no custom sync function is provided in the request body, the
14-
default or user-defined sync function for the collection is used.
13+
Runs a document through the Sync Function and returns the result.
14+
15+
If no custom sync function is provided in the request, the user-defined sync function for the collection is used (or the default).
1516
1617
The document being run through the sync function can be provided in one of the following ways:
1718
| `doc` property | `doc_id` property | Behaviour |
1819
| ----- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19-
| Set | Unset | The document body passed will be the `doc` value in the sync function, and `oldDoc` will be empty. |
20+
| Set | Unset | The document body passed will be the `doc` value in the sync function, and `oldDoc` will be empty. |
2021
| Unset | Set | The document of the given id will be fetched from the bucket/collection and will be passed in as the `doc` value in the sync function. If the document is not found, an error will be returned |
2122
| Set | Set | The document body passed will be the `doc` value in the sync function, and the `doc_id` will be fetched from the bucket/collection and will be the `oldDoc` value. If `doc_id` doesn't exist, then `oldDoc` will be empty |
22-
| Unset | Unset | Will throw an error (at least one of `doc` or `doc_id` is required) |
23+
| Unset | Unset | Will throw an error (at least one of `doc` or `doc_id` is required) |
2324
2425
* Sync Gateway Application Read Only
2526
requestBody:

0 commit comments

Comments
 (0)