Skip to content

Commit 024b2eb

Browse files
simon-dewsimon-dew
committed
Build output documentation
1 parent f2a6e9f commit 024b2eb

4 files changed

Lines changed: 41 additions & 41 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::partial$header-attributes.adoc[opts=optional]
88

99
[comment]
1010
This file is created automatically by OpenAPI Generator.
11-
DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger
11+
DO NOT EDIT! See https://github.com/couchbase/query
1212

1313
:leveloffset: 1
1414

‎docs/modules/n1ql-rest-functions/pages/index.adoc‎

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::partial$header-attributes.adoc[opts=optional]
88

99
[comment]
1010
This file is created automatically by OpenAPI Generator.
11-
DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger
11+
DO NOT EDIT! See https://github.com/couchbase/query
1212

1313
:leveloffset: 1
1414

@@ -174,7 +174,6 @@ Deletes the specified library entirely.
174174

175175
By default, this operation deletes a global library.
176176
For a scoped library, you must specify the bucket and scope.
177-
178177
--
179178

180179

@@ -243,8 +242,8 @@ a¦
243242

244243
[markdown]
245244
--
246-
For scoped libraries only. The bucket in which the library is stored.
247-
245+
For scoped libraries only.
246+
The bucket in which the library is stored.
248247
--
249248

250249
[%hardbreaks]
@@ -261,8 +260,8 @@ a¦
261260

262261
[markdown]
263262
--
264-
For scoped libraries only. The scope in which the library is stored.
265-
263+
For scoped libraries only.
264+
The scope in which the library is stored.
266265
--
267266

268267
[%hardbreaks]
@@ -313,13 +312,13 @@ a|
313312
| 400
314313
a| [markdown]
315314
--
316-
Bad request. The path may not conform to the schema.
315+
Bad request. The path may not conform to the schema.
317316
--
318317
a|
319318
| 404
320319
a| [markdown]
321320
--
322-
Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly.
321+
Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly.
323322
--
324323
a|
325324

@@ -421,8 +420,9 @@ GET /evaluator/v1/libraries
421420
--
422421
Returns all libraries and functions.
423422

424-
By default, this operation returns all global libraries and functions, and all scoped libraries and functions. To return all the libraries and functions in a single scope, specify a bucket and scope.
425423

424+
By default, this operation returns all global libraries and functions, and all scoped libraries and functions.
425+
To return all the libraries and functions in a single scope, specify a bucket and scope.
426426
--
427427

428428

@@ -468,8 +468,8 @@ a¦
468468

469469
[markdown]
470470
--
471-
For scoped libraries only. The bucket from which to fetch libraries.
472-
471+
For scoped libraries only.
472+
The bucket from which to fetch libraries.
473473
--
474474

475475
[%hardbreaks]
@@ -486,8 +486,8 @@ a¦
486486

487487
[markdown]
488488
--
489-
For scoped libraries only. The scope from which to fetch libraries.
490-
489+
For scoped libraries only.
490+
The scope from which to fetch libraries.
491491
--
492492

493493
[%hardbreaks]
@@ -540,7 +540,7 @@ a| xref:Libraries[]
540540
| 400
541541
a| [markdown]
542542
--
543-
Bad request. The path may not conform to the schema.
543+
Bad request. The path may not conform to the schema.
544544
--
545545
a|
546546

@@ -642,8 +642,9 @@ GET /evaluator/v1/libraries/{library}
642642
--
643643
Returns a library with all its functions.
644644

645-
By default, this operation returns a global library. For a scoped library, you must specify the bucket and scope.
646645

646+
By default, this operation returns a global library.
647+
For a scoped library, you must specify the bucket and scope.
647648
--
648649

649650

@@ -715,8 +716,8 @@ a¦
715716

716717
[markdown]
717718
--
718-
For scoped libraries only. The bucket in which the library is stored.
719-
719+
For scoped libraries only.
720+
The bucket in which the library is stored.
720721
--
721722

722723
[%hardbreaks]
@@ -733,8 +734,8 @@ a¦
733734

734735
[markdown]
735736
--
736-
For scoped libraries only. The scope in which the library is stored.
737-
737+
For scoped libraries only.
738+
The scope in which the library is stored.
738739
--
739740

740741
[%hardbreaks]
@@ -787,13 +788,13 @@ a| xref:Functions[]
787788
| 400
788789
a| [markdown]
789790
--
790-
Bad request. The path may not conform to the schema.
791+
Bad request. The path may not conform to the schema.
791792
--
792793
a|
793794
| 404
794795
a| [markdown]
795796
--
796-
Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly.
797+
Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly.
797798
--
798799
a|
799800

@@ -893,10 +894,12 @@ POST /evaluator/v1/libraries/{library}
893894

894895
[markdown]
895896
--
896-
Creates the specified library and its associated functions. If the specified library exists, the existing library is overwritten.
897+
Creates the specified library and its associated functions.
898+
If the specified library exists, the existing library is overwritten.
897899

898-
By default, this operation creates or updates a global library. For a scoped library, you must specify the bucket and scope.
899900

901+
By default, this operation creates or updates a global library.
902+
For a scoped library, you must specify the bucket and scope.
900903
--
901904

902905

@@ -968,8 +971,8 @@ a¦
968971

969972
[markdown]
970973
--
971-
For scoped libraries only. The bucket in which the library is stored.
972-
974+
For scoped libraries only.
975+
The bucket in which the library is stored.
973976
--
974977

975978
[%hardbreaks]
@@ -986,8 +989,8 @@ a¦
986989

987990
[markdown]
988991
--
989-
For scoped libraries only. The scope in which the library is stored.
990-
992+
For scoped libraries only.
993+
The scope in which the library is stored.
991994
--
992995

993996
[%hardbreaks]
@@ -1064,13 +1067,13 @@ a|
10641067
| 400
10651068
a| [markdown]
10661069
--
1067-
Bad request. The body of the request may be incorrect, or the path may not conform to the schema.
1070+
Bad request. The body of the request may be incorrect, or the path may not conform to the schema.
10681071
--
10691072
a|
10701073
| 404
10711074
a| [markdown]
10721075
--
1073-
Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly.
1076+
Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly.
10741077
--
10751078
a|
10761079

@@ -1203,7 +1206,7 @@ endif::collapse-models[]
12031206
¦ Property ¦ ¦ Schema
12041207

12051208
a¦
1206-
1209+
*{lt}library{gt}* +
12071210
_additional +
12081211
property_
12091212
a¦
@@ -1213,7 +1216,6 @@ a¦
12131216
The JavaScript code for all functions in the library.
12141217

12151218
The name of the property is the name of the library.
1216-
12171219
--
12181220

12191221
[%hardbreaks]
@@ -1286,8 +1288,8 @@ a¦
12861288

12871289
[markdown]
12881290
--
1289-
For scoped libraries, the bucket in which the library is stored. For global libraries, this string is empty.
1290-
1291+
For scoped libraries, the bucket in which the library is stored.
1292+
For global libraries, this string is empty.
12911293
--
12921294

12931295
[%hardbreaks]
@@ -1303,8 +1305,8 @@ a¦
13031305

13041306
[markdown]
13051307
--
1306-
For scoped libraries, the scope in which the library is stored. For global libraries, this string is empty.
1307-
1308+
For scoped libraries, the scope in which the library is stored.
1309+
For global libraries, this string is empty.
13081310
--
13091311

13101312
[%hardbreaks]
@@ -1321,7 +1323,6 @@ a¦
13211323
[markdown]
13221324
--
13231325
The JavaScript code for all functions in the library.
1324-
13251326
--
13261327

13271328
[%hardbreaks]
@@ -1385,7 +1386,6 @@ include::{specDir}security/document-begin.adoc[opts=optional]
13851386
To manage global libraries, users must have the *Manage Global External Functions* RBAC role.
13861387

13871388
This role enables you to create, read, update, or delete any global library, but does not give you access to any scoped libraries.
1388-
13891389
--
13901390

13911391
[%hardbreaks]
@@ -1419,7 +1419,6 @@ To manage scoped libraries, users must have the *Manage Scope External Functions
14191419

14201420
This role enables you to create, read, update, or delete any library in the scope to which you have access, but does not give you access to any other scoped libraries.
14211421
In addition, this role enables you to read any global library, but not to create, update, or delete them.
1422-
14231422
--
14241423

14251424
[%hardbreaks]

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::partial$header-attributes.adoc[opts=optional]
88

99
[comment]
1010
This file is created automatically by OpenAPI Generator.
11-
DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger
11+
DO NOT EDIT! See https://github.com/couchbase/query
1212

1313
:leveloffset: 1
1414

@@ -2670,6 +2670,7 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d
26702670
--
26712671

26722672
[%hardbreaks]
2673+
*Example:* `LAX`
26732674
{blank}
26742675
a¦ Any Type
26752676

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::partial$header-attributes.adoc[opts=optional]
88

99
[comment]
1010
This file is created automatically by OpenAPI Generator.
11-
DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger
11+
DO NOT EDIT! See https://github.com/couchbase/query
1212

1313
:leveloffset: 1
1414

0 commit comments

Comments
 (0)