From 5c5e290331ed2173fc6ea37b7612ac78b76faa4d Mon Sep 17 00:00:00 2001 From: Bryce Groff Date: Tue, 6 Dec 2022 15:04:01 -0800 Subject: [PATCH 1/2] Remove Change Management section as it was outdated. Added Authentication section to clarify how to use the API in OSS. --- airbyte-api/src/main/openapi/config.yaml | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/airbyte-api/src/main/openapi/config.yaml b/airbyte-api/src/main/openapi/config.yaml index d804575e987473..81264cb2486975 100644 --- a/airbyte-api/src/main/openapi/config.yaml +++ b/airbyte-api/src/main/openapi/config.yaml @@ -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. version: "1.0.0" title: Airbyte Configuration API From ded042fa6461091799dad0046295e04733aaa0f2 Mon Sep 17 00:00:00 2001 From: Bryce Groff Date: Tue, 6 Dec 2022 17:20:33 -0800 Subject: [PATCH 2/2] Update airbyte-api/src/main/openapi/config.yaml Co-authored-by: swyx --- airbyte-api/src/main/openapi/config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/airbyte-api/src/main/openapi/config.yaml b/airbyte-api/src/main/openapi/config.yaml index 81264cb2486975..6e243eae3fa108 100644 --- a/airbyte-api/src/main/openapi/config.yaml +++ b/airbyte-api/src/main/openapi/config.yaml @@ -13,7 +13,7 @@ info: * For all `update` methods, the whole object must be passed in, even the fields that did not change. 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. + * 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