Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update config for Redocly from sync_gateway source #782

Merged
merged 2 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
327 changes: 177 additions & 150 deletions modules/ROOT/assets/attachments/bundled-admin.yaml

Large diffs are not rendered by default.

46 changes: 36 additions & 10 deletions modules/ROOT/assets/attachments/bundled-metric.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,39 @@ servers:
hostname:
description: The hostname to use
default: localhost
tags:
- name: Prometheus
description: Endpoints for use with Prometheus
externalDocs:
description: Sync Gateway Quickstart | Couchbase Docs
url: https://docs.couchbase.com/sync-gateway/current/index.html
paths:
/_metrics:
/_ping:
get:
summary: Check if API is available
description: Returns OK status if API is available.
responses:
'200':
description: Returned status
content:
text/plain:
schema:
type: string
example: OK
tags:
- Server
operationId: get__ping
head:
responses:
'200':
description: Server is available
tags:
- Server
summary: Check if API is available
description: Returns OK status if API is available.
operationId: head__ping
/_metrics:
get: &ref_0
summary: Debugging/monitoring runtime stats in Prometheus Exposition format
description: |-
Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format.
Expand All @@ -40,7 +70,9 @@ paths:
type: string
tags:
- Prometheus
operationId: get__metrics
operationId: get_metrics
/metrics:
get: *ref_0
/_expvar:
get:
summary: Get all Sync Gateway statistics
Expand All @@ -61,7 +93,7 @@ paths:
application/javascript:
schema:
type: object
properties: &ref_0
properties: &ref_1
cmdline:
description: Built-in variables from the Go runtime, lists the command-line arguments
type: object
Expand Down Expand Up @@ -262,14 +294,8 @@ paths:
type: integer
deprecated: true
operationId: get__expvar
tags:
- name: Prometheus
description: Endpoints for use with Prometheus
externalDocs:
description: Sync Gateway Quickstart | Couchbase Docs
url: https://docs.couchbase.com/sync-gateway/current/index.html
components:
schemas:
ExpVars:
type: object
properties: *ref_0
properties: *ref_1
64 changes: 44 additions & 20 deletions modules/ROOT/assets/attachments/bundled-public.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,26 @@ servers:
hostname:
description: The hostname to use
default: localhost
tags:
- name: Server
description: Manage server activities
- name: Database Management
description: Create and manage Sync Gateway databases
- name: Session
description: Manage user sessions
- name: Authentication
description: Manage OpenID Connect Authentication
- name: Document
description: Create and manage documents
- name: Document Attachment
description: Create and manage document attachments
- name: Replication
description: Create and manage inter-Sync Gateway replications
- name: Unsupported
description: Endpoints that are not supported by Sync Gateway
externalDocs:
description: Sync Gateway Quickstart | Couchbase Docs
url: https://docs.couchbase.com/sync-gateway/current/index.html
paths:
/{db}/_session:
parameters:
Expand Down Expand Up @@ -362,6 +382,30 @@ paths:
summary: Check if server online
description: Check if the server is online by checking the status code of response.
operationId: head_-
/_ping:
get:
summary: Check if API is available
description: Returns OK status if API is available.
responses:
'200':
description: Returned status
content:
text/plain:
schema:
type: string
example: OK
tags:
- Server
operationId: get__ping
head:
responses:
'200':
description: Server is available
tags:
- Server
summary: Check if API is available
description: Returns OK status if API is available.
operationId: head__ping
/{keyspace}/:
parameters:
- name: keyspace
Expand Down Expand Up @@ -2881,26 +2925,6 @@ paths:
tags:
- Replication
operationId: get_db-_blipsync
tags:
- name: Server
description: Manage server activities
- name: Database Management
description: Create and manage Sync Gateway databases
- name: Session
description: Manage user sessions
- name: Authentication
description: Manage OpenID Connect Authentication
- name: Document
description: Create and manage documents
- name: Document Attachment
description: Create and manage document attachments
- name: Replication
description: Create and manage inter-Sync Gateway replications
- name: Unsupported
description: Endpoints that are not supported by Sync Gateway
externalDocs:
description: Sync Gateway Quickstart | Couchbase Docs
url: https://docs.couchbase.com/sync-gateway/current/index.html
components:
parameters:
db:
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6.5.0
7.3.0
Loading