Skip to content

Commit 5f5fbd3

Browse files
committed
CBG-4143 add redocly targets for capella
1 parent 8aa0c89 commit 5f5fbd3

File tree

3 files changed

+79
-0
lines changed

3 files changed

+79
-0
lines changed

.redocly.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ apis:
1515
remove-x-internal: on
1616
admin-internal:
1717
root: "./docs/api/admin.yaml"
18+
admin-capella:
19+
root: "./docs/api/admin-capella.yaml"
1820
public:
1921
root: "./docs/api/public.yaml"
2022
decorators:
@@ -27,6 +29,8 @@ apis:
2729
remove-x-internal: on
2830
metric-internal:
2931
root: "./docs/api/metric.yaml"
32+
metric-capella:
33+
root: "./docs/api/metric-capella.yaml"
3034
diagnostic:
3135
root: "./docs/api/diagnostic.yaml"
3236
decorators:

docs/api/admin-capella.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Copyright 2022-Present Couchbase, Inc.
2+
#
3+
# Use of this software is governed by the Business Source License included
4+
# in the file licenses/BSL-Couchbase.txt. As of the Change Date specified
5+
# in that file, in accordance with the Business Source License, use of this
6+
# software will be governed by the Apache License, Version 2.0, included in
7+
# the file licenses/APL2.txt.
8+
9+
openapi: 3.0.3
10+
info:
11+
title: Sync Gateway
12+
description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server
13+
version: 3.3.0
14+
license:
15+
name: Business Source License 1.1 (BSL)
16+
url: 'https://github.com/couchbase/sync_gateway/blob/master/LICENSE'
17+
servers:
18+
- url: 'https://{hostname}:4985'
19+
description: Admin API
20+
variables:
21+
hostname:
22+
description: The hostname to use
23+
default: localhost
24+
paths:
25+
'/{db}/_session':
26+
$ref: './paths/admin/db-_session.yaml'
27+
x-capella: true
28+
'/{db}/_session/{sessionid}':
29+
$ref: './paths/admin/db-_session-sessionid.yaml'
30+
'/{db}/_user/{name}':
31+
$ref: './paths/admin/db-_user-name.yaml'
32+
'/{db}/_user/{name}/_session':
33+
$ref: './paths/admin/db-_user-name-_session.yaml'
34+
'/{db}/_user/{name}/_session/{sessionid}':
35+
$ref: './paths/admin/db-_user-name-_session-sessionid.yaml'
36+
'/{db}/_role/':
37+
$ref: './paths/admin/db-_role-.yaml'
38+
'/{db}/_role/{name}':
39+
$ref: './paths/admin/db-_role-name.yaml'
40+
41+
externalDocs:
42+
description: Manage App Services for Mobile and Edge | Couchbase Docs
43+
url: 'https://docs.couchbase.com/cloud/app-services/index.html'

docs/api/metric-capella.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Copyright 2022-Present Couchbase, Inc.
2+
#
3+
# Use of this software is governed by the Business Source License included
4+
# in the file licenses/BSL-Couchbase.txt. As of the Change Date specified
5+
# in that file, in accordance with the Business Source License, use of this
6+
# software will be governed by the Apache License, Version 2.0, included in
7+
# the file licenses/APL2.txt.
8+
9+
openapi: 3.0.3
10+
info:
11+
title: Sync Gateway
12+
description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server
13+
version: 3.3.0
14+
license:
15+
name: Business Source License 1.1 (BSL)
16+
url: 'https://github.com/couchbase/sync_gateway/blob/master/LICENSE'
17+
servers:
18+
- url: 'https://{hostname}:4986'
19+
description: Metrics API
20+
variables:
21+
hostname:
22+
description: The hostname to use
23+
default: localhost
24+
paths:
25+
/_metrics:
26+
$ref: ./paths/metric/metrics.yaml
27+
tags:
28+
- name: Prometheus
29+
description: Endpoints for use with Prometheus
30+
externalDocs:
31+
description: Manage App Services for Mobile and Edge | Couchbase Docs
32+
url: 'https://docs.couchbase.com/cloud/app-services/index.html'

0 commit comments

Comments
 (0)