Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
4 changes: 4 additions & 0 deletions .redocly.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ apis:
remove-x-internal: on
admin-internal:
root: "./docs/api/admin.yaml"
admin-capella:
root: "./docs/api/admin-capella.yaml"
public:
root: "./docs/api/public.yaml"
decorators:
Expand All @@ -27,6 +29,8 @@ apis:
remove-x-internal: on
metric-internal:
root: "./docs/api/metric.yaml"
metric-capella:
root: "./docs/api/metric-capella.yaml"
diagnostic:
root: "./docs/api/diagnostic.yaml"
decorators:
Expand Down
43 changes: 43 additions & 0 deletions docs/api/admin-capella.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Copyright 2022-Present Couchbase, Inc.
#
# Use of this software is governed by the Business Source License included
# in the file licenses/BSL-Couchbase.txt. As of the Change Date specified
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

openapi: 3.0.3
info:
title: Sync Gateway
description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server
version: 3.3.0
license:
name: Business Source License 1.1 (BSL)
url: 'https://github.com/couchbase/sync_gateway/blob/master/LICENSE'
servers:
- url: 'https://{hostname}:4985'
description: Admin API
variables:
hostname:
description: The hostname to use
default: localhost
paths:
'/{db}/_session':
$ref: './paths/admin/db-_session.yaml'
x-capella: true
Copy link
Member

@IsaacLambat IsaacLambat Aug 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good just a minor point.
How come this has been added here but nowhere else?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this would work to use filter-in but it does not because filter-in only works if a property is defined. I think it'd be too much to remember to define a property on every operation.

This was an artifact from a previous experiment. Any properties with x- are ignored by openapi and redocly unless redocly gives them special meanings.

'/{db}/_session/{sessionid}':
$ref: './paths/admin/db-_session-sessionid.yaml'
'/{db}/_user/{name}':
$ref: './paths/admin/db-_user-name.yaml'
'/{db}/_user/{name}/_session':
$ref: './paths/admin/db-_user-name-_session.yaml'
'/{db}/_user/{name}/_session/{sessionid}':
$ref: './paths/admin/db-_user-name-_session-sessionid.yaml'
'/{db}/_role/':
$ref: './paths/admin/db-_role-.yaml'
'/{db}/_role/{name}':
$ref: './paths/admin/db-_role-name.yaml'

externalDocs:
description: Manage App Services for Mobile and Edge | Couchbase Docs
url: 'https://docs.couchbase.com/cloud/app-services/index.html'
32 changes: 32 additions & 0 deletions docs/api/metric-capella.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Copyright 2022-Present Couchbase, Inc.
#
# Use of this software is governed by the Business Source License included
# in the file licenses/BSL-Couchbase.txt. As of the Change Date specified
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

openapi: 3.0.3
info:
title: Sync Gateway
description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server
version: 3.3.0
license:
name: Business Source License 1.1 (BSL)
url: 'https://github.com/couchbase/sync_gateway/blob/master/LICENSE'
servers:
- url: 'https://{hostname}:4988'
description: Metrics API
variables:
hostname:
description: The hostname to use
default: localhost
paths:
/metrics:
$ref: ./paths/metric/metrics.yaml
tags:
- name: Prometheus
description: Endpoints for use with Prometheus
externalDocs:
description: Manage App Services for Mobile and Edge | Couchbase Docs
url: 'https://docs.couchbase.com/cloud/app-services/index.html'
Loading