Skip to content

Commit 360e438

Browse files
author
Tim Roes
authored
Mark web backend APIs as non-public (#9813)
1 parent e53e290 commit 360e438

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

airbyte-api/src/main/openapi/config.yaml

+4-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ info:
1818
* All backwards incompatible changes will happen in major version bumps. We will not make backwards incompatible changes in minor version bumps. Examples of non-breaking changes (includes but not limited to...):
1919
* Adding fields to request or response bodies.
2020
* Adding new HTTP endpoints.
21+
* All `web_backend` APIs are not considered public APIs and are not guaranteeing backwards compatibility.
2122
2223
version: "1.0.0"
2324
title: Airbyte Configuration API
@@ -53,7 +54,9 @@ tags:
5354
- name: db_migration
5455
description: Database migration related resources.
5556
- name: web_backend
56-
description: Connection between sources and destinations.
57+
description: |
58+
Endpoints for the Airbyte web application. Those APIs should not be called outside the web application implementation and are not
59+
guaranteeing any backwards compatibility.
5760
- name: health
5861
description: Healthchecks
5962
- name: deployment

docs/reference/api/generated-api-html/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ <h1>Airbyte Configuration API</h1>
200200
<li>Adding new HTTP endpoints.</li>
201201
</ul>
202202
</li>
203+
<li>All <code>web_backend</code> APIs are not considered public APIs and are not guaranteeing backwards compatibility.</li>
203204
</ul>
204205
</div>
205206
<div class="app-desc">More information: <a href="https://openapi-generator.tech">https://openapi-generator.tech</a></div>

0 commit comments

Comments
 (0)