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.

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

Open API - connection definition file contains circular references that makes SDK generation impossible on NodeJS #52079

Open
ABitShift opened this issue Jan 22, 2025 · 2 comments

Comments

@ABitShift
Copy link

Topic

openapi api node sdk airbyte-server

Relevant information

Hi,

As the title suggest: it is currently impossible to generate the airbyte node SDK using api because the open api definition file contains circular references.

Reproduction:

  1. npx api install "https://github.com/airbytehq/airbyte-platform/blob/019a68c5f5445470f72506e198b992ae3cdf13a1/airbyte-api/server-api/src/main/openapi/api_documentation_connections.yaml" -i airbyte-api-connections -l ts -y
  2. see the error logs
    ⠋ Generating your SDKC:\Users\Izio\AppData\Local\npm-cache\_npx\334debcfbdc435a8\node_modules\api\dist\cli\codegen\language.js:24
            throw new Error('Sorry, this library does not yet support generating an SDK for an OpenAPI definition that contains circular references.');
    

Side node: it is very annoying having to generate a different SDK for each domains (application/sources/destinations/...), i'd prefer a concatenated and self sufficient OpenAPI file definition to generate a single Airbyte SDK.

@JonsSpaghetti
Copy link
Contributor

The specs you're trying to generate from are intended to be used by our team to generate our public api documentation.

We don't currently support a js/ts sdk but if you wanted to try to generate one, you could try to do so via the api_sdk.yaml in the same folder you found the documentation specs.

@ABitShift
Copy link
Author

We don't currently support a js/ts sdk

This is confusing on the API documentation (see image)

Image

I'm moving to using a different SDK generator, thanks for pointing out :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants