Skip to content

Commit ab52121

Browse files
authored
Update config for Redocly from sync_gateway source (#782)
* Update config for Redocly from sync_gateway source This will update x-internal settings. via #781 and discussion with @torcolvin * Update from release/3.1.3
1 parent ad3cdb8 commit ab52121

File tree

10 files changed

+1588
-445
lines changed

10 files changed

+1588
-445
lines changed

modules/ROOT/assets/attachments/bundled-admin.yaml

Lines changed: 177 additions & 150 deletions
Large diffs are not rendered by default.

modules/ROOT/assets/attachments/bundled-metric.yaml

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,39 @@ servers:
1919
hostname:
2020
description: The hostname to use
2121
default: localhost
22+
tags:
23+
- name: Prometheus
24+
description: Endpoints for use with Prometheus
25+
externalDocs:
26+
description: Sync Gateway Quickstart | Couchbase Docs
27+
url: https://docs.couchbase.com/sync-gateway/current/index.html
2228
paths:
23-
/_metrics:
29+
/_ping:
2430
get:
31+
summary: Check if API is available
32+
description: Returns OK status if API is available.
33+
responses:
34+
'200':
35+
description: Returned status
36+
content:
37+
text/plain:
38+
schema:
39+
type: string
40+
example: OK
41+
tags:
42+
- Server
43+
operationId: get__ping
44+
head:
45+
responses:
46+
'200':
47+
description: Server is available
48+
tags:
49+
- Server
50+
summary: Check if API is available
51+
description: Returns OK status if API is available.
52+
operationId: head__ping
53+
/_metrics:
54+
get: &ref_0
2555
summary: Debugging/monitoring runtime stats in Prometheus Exposition format
2656
description: |-
2757
Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format.
@@ -40,7 +70,9 @@ paths:
4070
type: string
4171
tags:
4272
- Prometheus
43-
operationId: get__metrics
73+
operationId: get_metrics
74+
/metrics:
75+
get: *ref_0
4476
/_expvar:
4577
get:
4678
summary: Get all Sync Gateway statistics
@@ -61,7 +93,7 @@ paths:
6193
application/javascript:
6294
schema:
6395
type: object
64-
properties: &ref_0
96+
properties: &ref_1
6597
cmdline:
6698
description: Built-in variables from the Go runtime, lists the command-line arguments
6799
type: object
@@ -262,14 +294,8 @@ paths:
262294
type: integer
263295
deprecated: true
264296
operationId: get__expvar
265-
tags:
266-
- name: Prometheus
267-
description: Endpoints for use with Prometheus
268-
externalDocs:
269-
description: Sync Gateway Quickstart | Couchbase Docs
270-
url: https://docs.couchbase.com/sync-gateway/current/index.html
271297
components:
272298
schemas:
273299
ExpVars:
274300
type: object
275-
properties: *ref_0
301+
properties: *ref_1

modules/ROOT/assets/attachments/bundled-public.yaml

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,26 @@ servers:
1919
hostname:
2020
description: The hostname to use
2121
default: localhost
22+
tags:
23+
- name: Server
24+
description: Manage server activities
25+
- name: Database Management
26+
description: Create and manage Sync Gateway databases
27+
- name: Session
28+
description: Manage user sessions
29+
- name: Authentication
30+
description: Manage OpenID Connect Authentication
31+
- name: Document
32+
description: Create and manage documents
33+
- name: Document Attachment
34+
description: Create and manage document attachments
35+
- name: Replication
36+
description: Create and manage inter-Sync Gateway replications
37+
- name: Unsupported
38+
description: Endpoints that are not supported by Sync Gateway
39+
externalDocs:
40+
description: Sync Gateway Quickstart | Couchbase Docs
41+
url: https://docs.couchbase.com/sync-gateway/current/index.html
2242
paths:
2343
/{db}/_session:
2444
parameters:
@@ -362,6 +382,30 @@ paths:
362382
summary: Check if server online
363383
description: Check if the server is online by checking the status code of response.
364384
operationId: head_-
385+
/_ping:
386+
get:
387+
summary: Check if API is available
388+
description: Returns OK status if API is available.
389+
responses:
390+
'200':
391+
description: Returned status
392+
content:
393+
text/plain:
394+
schema:
395+
type: string
396+
example: OK
397+
tags:
398+
- Server
399+
operationId: get__ping
400+
head:
401+
responses:
402+
'200':
403+
description: Server is available
404+
tags:
405+
- Server
406+
summary: Check if API is available
407+
description: Returns OK status if API is available.
408+
operationId: head__ping
365409
/{keyspace}/:
366410
parameters:
367411
- name: keyspace
@@ -2881,26 +2925,6 @@ paths:
28812925
tags:
28822926
- Replication
28832927
operationId: get_db-_blipsync
2884-
tags:
2885-
- name: Server
2886-
description: Manage server activities
2887-
- name: Database Management
2888-
description: Create and manage Sync Gateway databases
2889-
- name: Session
2890-
description: Manage user sessions
2891-
- name: Authentication
2892-
description: Manage OpenID Connect Authentication
2893-
- name: Document
2894-
description: Create and manage documents
2895-
- name: Document Attachment
2896-
description: Create and manage document attachments
2897-
- name: Replication
2898-
description: Create and manage inter-Sync Gateway replications
2899-
- name: Unsupported
2900-
description: Endpoints that are not supported by Sync Gateway
2901-
externalDocs:
2902-
description: Sync Gateway Quickstart | Couchbase Docs
2903-
url: https://docs.couchbase.com/sync-gateway/current/index.html
29042928
components:
29052929
parameters:
29062930
db:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.5.0
1+
7.3.0

0 commit comments

Comments
 (0)