Skip to content

Commit b8db87f

Browse files
committed
DOC-13510: Fix external example refs (#205)
* Update Query Settings to expect JSON examples * Build output documentation
1 parent 3ebf49b commit b8db87f

9 files changed

Lines changed: 11 additions & 40 deletions

File tree

docs/modules/n1ql-rest-admin/pages/index.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6795,7 +6795,6 @@ a¦
67956795
--
67966796
ifdef::alt-markdown-links[]
67976797
[queryNumAtrs]: #queryNumAtrs
6798-
[numatrs_req]: #numatrs_req
67996798

68006799
endif::alt-markdown-links[]
68016800
Specifies the total number of [active transaction records][additional-storage-use].
@@ -6806,11 +6805,7 @@ Specifies the total number of [active transaction records][additional-storage-us
68066805
The [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies this property for the whole cluster.
68076806
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
68086807

6809-
In addition, the [request-level][numatrs_req] `numatrs` parameter specifies this property per request.
6810-
The minimum of that and the node-level `numatrs` setting is applied.
6811-
68126808
[queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs
6813-
[numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req
68146809
// end::desc-more[]
68156810
--
68166811

docs/modules/n1ql-rest-query/pages/index.adoc

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1993,31 +1993,11 @@ a¦
19931993

19941994
[markdown]
19951995
--
1996-
ifdef::alt-markdown-links[]
1997-
[numatrs-srv]: #numatrs-srv
1998-
[queryNumAtrs]: #queryNumAtrs
1999-
2000-
endif::alt-markdown-links[]
2001-
Specifies the total number of [active transaction records][additional-storage-use].
2002-
Must be a positive integer.
2003-
2004-
[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries
2005-
2006-
// tag::desc-more[]
2007-
The [node-level][numatrs-srv] `numatrs` setting specifies the default for this parameter for a single node.
2008-
The request-level parameter overrides the node-level setting.
2009-
2010-
In addition, the [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies the default for this parameter for the whole cluster.
2011-
When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster.
2012-
2013-
[numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv
2014-
[queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs
2015-
// end::desc-more[]
1996+
Reserved for future use.
1997+
This parameter is ignored and has no effect.
20161998
--
20171999

20182000
[%hardbreaks]
2019-
*Default:* `1024`
2020-
*Example:* `512`
20212001
{blank}
20222002
a¦ Integer (int32)
20232003

@@ -2488,10 +2468,11 @@ ifdef::alt-markdown-links[]
24882468
[queryTimeout]: #queryTimeout
24892469

24902470
endif::alt-markdown-links[]
2491-
Maximum time to spend on the request before timing out.
2471+
Maximum time to spend on the request before timing out (s).
24922472

24932473
The value for this parameter is a string.
2494-
Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second).
2474+
Its format includes an amount and an optional unit: for example, `10ms` (10 milliseconds) or `0.5s` (half a second).
2475+
If not specified, the default unit is `s` (seconds).
24952476
Valid units are:
24962477

24972478
* `ns` (nanoseconds)

docs/modules/n1ql-rest-settings/examples/query-settings-get-access.jsonc renamed to docs/modules/n1ql-rest-settings/examples/query-settings-get-access.json

File renamed without changes.

docs/modules/n1ql-rest-settings/examples/query-settings-get-settings.jsonc renamed to docs/modules/n1ql-rest-settings/examples/query-settings-get-settings.json

File renamed without changes.

docs/modules/n1ql-rest-settings/examples/query-settings-post-access.jsonc renamed to docs/modules/n1ql-rest-settings/examples/query-settings-post-access.json

File renamed without changes.

docs/modules/n1ql-rest-settings/examples/query-settings-post-settings.jsonc renamed to docs/modules/n1ql-rest-settings/examples/query-settings-post-settings.json

File renamed without changes.

docs/modules/n1ql-rest-settings/examples/query-settings-post-snippet.jsonc renamed to docs/modules/n1ql-rest-settings/examples/query-settings-post-snippet.json

File renamed without changes.

docs/modules/n1ql-rest-settings/pages/index.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The URL scheme. Use `https` for secure access.
6363
a| *host*
6464
a| [markdown]
6565
--
66-
The host name or IP address of a node running the Query Service.
66+
The host name or IP address of any node in the Couchbase cluster.
6767
--
6868

6969
[%hardbreaks]
@@ -1432,7 +1432,6 @@ a¦
14321432
--
14331433
ifdef::alt-markdown-links[]
14341434
[numatrs-srv]: #numatrs-srv
1435-
[numatrs_req]: #numatrs_req
14361435

14371436
endif::alt-markdown-links[]
14381437
Specifies the total number of [active transaction records][additional-storage-use] for all Query nodes in the cluster.
@@ -1443,11 +1442,7 @@ Specifies the total number of [active transaction records][additional-storage-us
14431442
The [node-level][numatrs-srv] `numatrs` setting specifies this property for a single node.
14441443
When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster.
14451444

1446-
In addition, there is a [request-level][numatrs_req] `numatrs` parameter.
1447-
If a request includes this parameter, it will be capped by the node-level `numatrs` setting.
1448-
14491445
[numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv
1450-
[numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req
14511446
// end::desc-more[]
14521447
--
14531448

docs/modules/n1ql-rest-settings/query-settings.gradle

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ tasks.register('getExamples') {
66
value: "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/settings/examples")
77
ant.echo("Fetching from ${ant.srcUrl}")
88
ant.get(dest: "examples", ignoreerrors: "true") {
9-
ant.url(url: "${ant.srcUrl}/query-settings-get-access.jsonc")
9+
ant.url(url: "${ant.srcUrl}/query-settings-get-access.json")
1010
ant.url(url: "${ant.srcUrl}/query-settings-get-access.sh")
11-
ant.url(url: "${ant.srcUrl}/query-settings-get-settings.jsonc")
11+
ant.url(url: "${ant.srcUrl}/query-settings-get-settings.json")
1212
ant.url(url: "${ant.srcUrl}/query-settings-get-settings.sh")
13-
ant.url(url: "${ant.srcUrl}/query-settings-post-access.jsonc")
13+
ant.url(url: "${ant.srcUrl}/query-settings-post-access.json")
1414
ant.url(url: "${ant.srcUrl}/query-settings-post-access.sh")
15-
ant.url(url: "${ant.srcUrl}/query-settings-post-settings.jsonc")
15+
ant.url(url: "${ant.srcUrl}/query-settings-post-settings.json")
1616
ant.url(url: "${ant.srcUrl}/query-settings-post-settings.sh")
17-
ant.url(url: "${ant.srcUrl}/query-settings-post-snippet.jsonc")
17+
ant.url(url: "${ant.srcUrl}/query-settings-post-snippet.json")
1818
}
1919
}
2020
}

0 commit comments

Comments
 (0)