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.

Sign up for GitHub

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

Jump to bottom

Remove Change Management section as it was outdated. Added Authentication section to clarify how to use the API in OSS. #20167

Merged
merged 2 commits into from
Dec 7, 2022
Merged

Remove Change Management section as it was outdated. Added Authentication section to clarify how to use the API in OSS. #20167

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c5e290
Remove Change Management section as it was outdated. Added Authentica…
bgroff Dec 6, 2022
ded042f
Update airbyte-api/src/main/openapi/config.yaml
bgroff Dec 7, 2022
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
9 changes: 2 additions & 7 deletions airbyte-api/src/main/openapi/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,8 @@ info:
* The naming convention for endpoints is: localhost:8000/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. `localhost:8000/v1/connections/create`.
* For all `update` methods, the whole object must be passed in, even the fields that did not change.

Change Management:
* The major version of the API endpoint can be determined / specified in the URL `localhost:8080/v1/connections/create`
* Minor version bumps will be invisible to the end user. The user cannot specify minor versions in requests.
* 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...):
* Adding fields to request or response bodies.
* Adding new HTTP endpoints.
* All `web_backend` APIs are not considered public APIs and are not guaranteeing backwards compatibility.
Authentication (OSS):
* When authenticating to the Configuration API, you must use Basic Authentication by setting the Authentication Header to Basic and base64 encoding the username and password, airbyte and password by default. See https://github.com/airbytehq/airbyte#quick-start for more details.
bgroff marked this conversation as resolved.
Show resolved Hide resolved

version: "1.0.0"
title: Airbyte Configuration API
Expand Down