SDK Documentation

[righthill]

Hello - can you please advice where I can find SDK doc? Is it available online or need to use the yarn gen-sdk <sdk-version> ? If the later, we were able to execute it but not sure how to access/view the generated doc - please kindly advice.

Thank you for creating this node library, super helpful to access to the Circle APIs.

Regards,
Right

[bombillazo]

Docs would be great!

[ashutosh-ukey]

Hi @righthill, actually, the command yarn gen-sdk <sdk-version> is used to regenerate the source code of the SDK from the file sdk.json (an OpenAPI document). This file should be available already in the repo's root folder.

In your original question, were you referring to a detailed documentation of all the methods / classes available in the SDK?

[christian-suwiryo]

hi @ashutosh-ukey, correct - doc on available classes and methods in SDK would be great!! Can you point me to the right location? Thank you!

[ashutosh-ukey]

Hey @christian-suwiryo, we unfortunately don't have separate documentation available for all classes and methods for this Node SDK yet. However, each of the classes and methods can be easily found within the source code in this repo with descriptive comments:

• For a list of all of the methods available in this SDK, take a look at the files within this folder: https://github.com/circlefin/circle-nodejs-sdk/tree/master/src/generated/apis
• For a list of all the models (each model has its own file), see this folder: https://github.com/circlefin/circle-nodejs-sdk/tree/master/src/generated/models

We also have a "Getting started" guide for the SDK with some example code snippets: https://developers.circle.com/developer/docs/circle-sdk.

Considering there seems to be interest in having additional documentation for all the methods and classes in the SDK, I will bring this issue up with my team and see what we can do. Thanks!

[christian-suwiryo]

Hey @christian-suwiryo, we unfortunately don't have separate documentation available for all classes and methods for this Node SDK yet. However, each of the classes and methods can be easily found within the source code in this repo with descriptive comments:

• For a list of all of the methods available in this SDK, take a look at the files within this folder: https://github.com/circlefin/circle-nodejs-sdk/tree/master/src/generated/apis
• For a list of all the models (each model has its own file), see this folder: https://github.com/circlefin/circle-nodejs-sdk/tree/master/src/generated/models

We also have a "Getting started" guide for the SDK with some example code snippets: https://developers.circle.com/developer/docs/circle-sdk.

Considering there seems to be interest in having additional documentation for all the methods and classes in the SDK, I will bring this issue up with my team and see what we can do. Thanks!

Thank you @ashutosh-ukey!! Much appreciated.

[CarsonRoscoe]

We also have a "Getting started" guide for the SDK with some example code snippets: https://developers.circle.com/developer/docs/circle-sdk.

Future readers, the URL changed, presumably as more languages became supported. The new URL is https://developers.circle.com/developer/docs/circle-sdks

[sc0Vu]

Is this possible to generate documentation with these generators (https://openapi-generator.tech/docs/generators/#documentation-generators)?