-
Notifications
You must be signed in to change notification settings - Fork 138
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
5ba7cd0
commit 4c4fca0
Showing
36 changed files
with
901 additions
and
188 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Copyright 2024-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. | ||
|
||
name: openapi-pr | ||
|
||
on: | ||
pull_request: | ||
# Only run when we change an API spec | ||
paths: | ||
- 'docs/api/**' | ||
branches: | ||
- 'master' | ||
- 'main' | ||
- 'release/*' | ||
- 'beryllium' | ||
|
||
jobs: | ||
redocly_preview_links: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Find Comment | ||
uses: peter-evans/find-comment@v3 | ||
id: fc | ||
with: | ||
issue-number: ${{ github.event.pull_request.number }} | ||
comment-author: 'github-actions[bot]' | ||
body-includes: Redocly previews | ||
- name: Create or update comment | ||
uses: peter-evans/create-or-update-comment@v4 | ||
with: | ||
comment-id: ${{ steps.fc.outputs.comment-id }} | ||
issue-number: ${{ github.event.pull_request.number }} | ||
body: | | ||
## Redocly previews | ||
- [Admin API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/admin.yaml) | ||
- [Public API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/public.yaml) | ||
- [Metric API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/metric.yaml) | ||
- [Diagnostic API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/diagnostic.yaml) | ||
edit-mode: replace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Copyright 2023-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. | ||
|
||
--- | ||
|
||
extends: default | ||
|
||
rules: | ||
document-start: disable | ||
line-length: disable | ||
comments: disable | ||
truthy: disable |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Sync Gateway OpenAPI Specs | ||
|
||
This directory contains the OpenAPI specs for the Sync Gateway REST API. | ||
|
||
The recommended tool to work with these specs is [Redocly](https://redoc.ly/). | ||
|
||
## Preview | ||
|
||
```sh | ||
$ redocly preview-docs | ||
``` | ||
|
||
## Linting | ||
|
||
```sh | ||
$ redocly lint | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# 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: App Services Admin API | ||
description: 'App Services manages access and synchronization between Couchbase Lite and Couchbase Capella' | ||
version: '3.1' | ||
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' | ||
'/{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' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.