Skip to content

Commit

Permalink
Remove Change Management section as it was outdated. Added Authentica…
Browse files Browse the repository at this point in the history
…tion section to clarify how to use the API in OSS. (#20167)

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

Co-authored-by: swyx <shawnthe1@gmail.com>
  • Loading branch information
bgroff and swyxio committed Dec 7, 2022
1 parent 61ddba6 commit 0f8c39c
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions airbyte-api/src/main/openapi/config.yaml
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 (which are `airbyte` and `password` by default - so base64 encoding `airbyte:password` results in `YWlyYnl0ZTpwYXNzd29yZA==`). So the full header reads `'Authorization': "Basic YWlyYnl0ZTpwYXNzd29yZA=="`
version: "1.0.0"
title: Airbyte Configuration API
Expand Down

0 comments on commit 0f8c39c

Please sign in to comment.